Improve keyboard usage for menu search popup #51087

New Issue

blend-it · 2017-03-30T10:50:07+02:00

blend-it commented

2017-03-30 10:50:07 +02:00

System Information
NA

Blender Version
Broken: example: 2.78
Worked: >new feature request<

Short description of error
when spacebar search menu popups and user start writing the required command, only down-arrow keyboard shortcut are allowed to select the required command, starting from first item on top.
It will be very useful and faster if also up-arrow can be usable to select the last item in the list (so starting from bottom).
See image as reference: green arrow show the required feature, red one is the only one actually working.

Exact steps for others to reproduce the error
not an error, only UI usage improvement :)

**System Information** NA **Blender Version** Broken: example: 2.78 Worked: >new feature request< **Short description of error** when spacebar search menu popups and user start writing the required command, only down-arrow keyboard shortcut are allowed to select the required command, starting from first item on top. It will be very useful and faster if also up-arrow can be usable to select the last item in the list (so starting from bottom). See image as reference: green arrow show the required feature, red one is the only one actually working. ![spacebar-search.png](https://archive.blender.org/developer/F528627/spacebar-search.png) **Exact steps for others to reproduce the error** not an error, only UI usage improvement :)

blend-it commented

2017-03-30 10:50:07 +02:00

Changed status to: 'Open'

blend-it commented

2017-03-30 10:50:07 +02:00

Added subscriber: @blend-it

Germano Cavalcante commented

2017-03-30 20:29:00 +02:00

Added subscribers: @JulianEisel, @mano-wii

Germano Cavalcante commented

2017-03-30 20:29:00 +02:00

This does not seem complicated, and would really be useful!
@JulianEisel, could you take a look?

This does not seem complicated, and would really be useful! @JulianEisel, could you take a look?

Campbell Barton commented

2017-03-31 00:33:43 +02:00

Added subscriber: @ideasman42

Campbell Barton commented

2017-03-31 00:33:43 +02:00

Seems reasonable, moved to quick hacks since this is a nice one for new developers.

blend-it commented

2017-03-31 10:36:18 +02:00

I always propose easy and fast hacks, but unfortunately I'm not a coder, so I can't do it myself (and I don't want broke something) ;)

Karina Antonio commented

2017-04-03 04:28:58 +02:00

Added subscriber: @karinafantonio

Karina Antonio self-assigned this 2017-04-03 04:28:58 +02:00

Karina Antonio commented

2017-04-03 04:28:58 +02:00

Hi, first-time contributor here! I've created a patch with this new feature, plus a short screencast attached.

One issue evident in the screencast is how long it takes to wrap from the top of the searchbox to the bottom for long item lists. This happens because I'm calling ui_searchbox_update in a loop, but I don't know any other way to access the end of the item list/the size of the item list. Furthermore, where is the value of items.more assigned?

searchbox_wrap.diff
searchbox_wrap_demo.mp4
Any feedback is greatly appreciated!

Hi, first-time contributor here! I've created a patch with this new feature, plus a short screencast attached. One issue evident in the screencast is how long it takes to wrap from the top of the searchbox to the bottom for long item lists. This happens because I'm calling `ui_searchbox_update` in a loop, but I don't know any other way to access the end of the item list/the size of the item list. Furthermore, where is the value of items.more assigned? [searchbox_wrap.diff](https://archive.blender.org/developer/F532399/searchbox_wrap.diff) [searchbox_wrap_demo.mp4](https://archive.blender.org/developer/F532404/searchbox_wrap_demo.mp4) Any feedback is greatly appreciated!

Germano Cavalcante commented

2017-04-03 07:29:18 +02:00

Hi @karinafantonio,

I liked your code but one thing worries me...
It's this part:

while (data->items.more) {
	data->items.offset++;
	data->active = data->items.totitem - 1;
	ui_searchbox_update(C, ar, but, false);
}

We can have about 2000 items in a list
ui_searchbox_update in a loop can be quite inefficient.
So, if it were not for this detail, I think the patch would already be good to commit.

Hi @karinafantonio, I liked your code but one thing worries me... It's this part: ``` while (data->items.more) { data->items.offset++; data->active = data->items.totitem - 1; ui_searchbox_update(C, ar, but, false); } ``` We can have about 2000 items in a list `ui_searchbox_update` in a loop can be quite inefficient. So, if it were not for this detail, I think the patch would already be good to commit.

Karina Antonio commented

2017-04-03 07:44:42 +02:00

Ahh, I see. Here's the updated patch with that part removed.

Using (and making!) this patch feels really nice!

searchbox_wrap.diff

Ahh, I see. Here's the updated patch with that part removed. Using (and making!) this patch feels really nice! [searchbox_wrap.diff](https://archive.blender.org/developer/F532693/searchbox_wrap.diff)

blend-it commented

2017-04-03 10:38:09 +02:00

Thanks for working on this feature :)
I nothing understand about the code, but if there are a performance issue, I can suggest you can trigger your routine only when:

letters in searchbox are more than 3,4 or 5 (the consequent list is shorter so faster to process,) and/or
the list itself is shorter than 6-10 items (is less useful to scroll from bottom if the last item is not visible to the user).

Thanks for working on this feature :) I nothing understand about the code, but if there are a performance issue, I can suggest you can trigger your routine only when: - letters in searchbox are more than 3,4 or 5 (the consequent list is shorter so faster to process,) and/or - the list itself is shorter than 6-10 items (is less useful to scroll from bottom if the last item is not visible to the user).

Karina Antonio commented

2017-04-03 10:49:37 +02:00

Hi, no problem, it was fun to do and a nice feature to have! ^^

The patch adds scrolling from bottom to top for all list sizes, and scrolling from top to bottom only when the entire list is visible (so when the list is <= 10 items). No performance issues at all for these cases, there are only issues for the case of wrapping from top to bottom with large lists with many not-visible items (so my latest patch disabled wrapping in this case).

Hi, no problem, it was fun to do and a nice feature to have! ^^ The patch adds scrolling from bottom to top for all list sizes, and scrolling from top to bottom only when the entire list is visible (so when the list is <= 10 items). No performance issues at all for these cases, there are only issues for the case of wrapping from top to bottom with large lists with many not-visible items (so my latest patch disabled wrapping in this case).

Campbell Barton commented

2017-04-05 05:48:33 +02:00

@blend-it changing behavior based on number of letters typed will seem buggy from user perspective.

I don't see why wrapping the list would have to be a slow operation.

@blend-it changing behavior based on number of letters typed will seem buggy from user perspective. I don't see why wrapping the list would have to be a slow operation.

blend-it commented

2017-04-07 09:44:46 +02:00

@ideasman42 About the number of letters typed, I understand your point, but with less of 3/4 letters the list is so long and user can't see the bottom, so I think nobody try to scroll from an "invisible" bottom.
Anyway, I can't compile and try to check performance, so if you don't find this kind of issues, no problem!
Thanks to all and I hope to find the feature in 2.79 ;)

@ideasman42 About the number of letters typed, I understand your point, but with less of 3/4 letters the list is so long and user can't see the bottom, so I think nobody try to scroll from an "invisible" bottom. Anyway, I can't compile and try to check performance, so if you don't find this kind of issues, no problem! Thanks to all and I hope to find the feature in 2.79 ;)

Dino Tabakovic commented

2017-11-22 14:26:35 +01:00

Added subscriber: @Dinulja

blend-it commented

2018-01-14 15:24:03 +01:00

the patch was not included in 2.79.... it's possible for 2.79a? :)

tung commented

2018-01-25 18:33:33 +01:00

Added subscriber: @kouhaku111

tung commented

2018-01-26 17:02:04 +01:00

where can i find the definition of data->active, items.totitem, items.more and items.offset

Martin Sand commented

2018-07-29 12:02:30 +02:00

Added subscriber: @sandstorm

Martin Sand commented

2018-07-29 12:02:30 +02:00

Is there a commit for this patch? I compiled the latest version and it does not work as in the video.

Durgesh commented

2018-07-29 13:41:52 +02:00

Added subscriber: @durgesh

Durgesh commented

2018-07-29 13:41:52 +02:00

I am working on improving the patch

JONG HA SIN commented

2018-10-17 13:42:13 +02:00

Added subscriber: @REMBO

JONG HA SIN commented

2018-10-17 13:42:14 +02:00

Is this task not done? Can I progress it?

Kalyan commented

2019-05-01 23:04:59 +02:00

Added subscriber: @KalyanS

Kalyan commented

2019-05-01 23:04:59 +02:00

This comment was removed by @KalyanS

*This comment was removed by @KalyanS*

Frederik Claessens commented

2019-12-06 01:53:32 +01:00

Added subscriber: @Fre2910

Carlos Barret commented

2019-12-10 10:37:32 +01:00

Added subscriber: @carlosedubarreto

Don Miguel commented

2020-02-11 18:04:48 +01:00

Added subscriber: @don.miguel

Don Miguel commented

2020-02-11 18:04:48 +01:00

Hello, the patch does not seem to work so I worked on a different approach. If anyone is interested, here is my submitted patch .

Hello, the patch does not seem to work so I worked on a different approach. If anyone is interested, here is my [submitted patch ](https://developer.blender.org/D6813).

Faraz commented

2020-03-23 20:38:05 +01:00

Added subscriber: @Faraz-007

Faraz commented

2020-03-23 20:42:11 +01:00

Removed subscriber: @Faraz-007

Jaap commented

2020-04-09 15:06:23 +02:00

Added subscriber: @lemagedurage

Jaap commented

2020-04-09 15:06:23 +02:00

Hi there!

Since I couldn't get previous patches to apply / work properly, and because I'm doing a course for my university, I dived into this issue too.
This issue is harder than it might look because the underlying data structure is an iterator, which doesn't expose the total amount of search results. Wrapping from the bottom item to the top one is trivial, but wrapping from the top item to the bottom one is not.

Based on Karina's and Don's work, I created a somewhat simplified patch here that should work fine on the current master branch.

Testers and feedback are welcome. I hope this little feature can be added soon.

Hi there! Since I couldn't get previous patches to apply / work properly, and because I'm doing a course for my university, I dived into this issue too. This issue is harder than it might look because the underlying data structure is an iterator, which doesn't expose the total amount of search results. Wrapping from the bottom item to the top one is trivial, but wrapping from the top item to the bottom one is not. Based on Karina's and Don's work, I created a somewhat simplified patch [here ](https://developer.blender.org/differential/diff/23590/) that should work fine on the current master branch. Testers and feedback are welcome. I hope this little feature can be added soon.

Scott Wilson commented

2020-05-14 03:09:28 +02:00

Added subscriber: @propersquid

Paul De Temmerman commented

2020-07-24 19:58:58 +02:00

Added subscriber: @paul2t

Paul De Temmerman commented

2020-07-24 19:58:58 +02:00

In #51087#906688, @lemagedurage wrote:
Based on Karina's and Don's work, I created a somewhat simplified patch here that should work fine on the current master branch.

Hello Jaap,
You need to create a new Revision from this diff and attach it to this task.
Then, someone will review it.

> In #51087#906688, @lemagedurage wrote: > Based on Karina's and Don's work, I created a somewhat simplified patch [here ](https://developer.blender.org/differential/diff/23590/) that should work fine on the current master branch. Hello Jaap, You need to create a new Revision from this diff and attach it to this task. Then, someone will review it.

Campbell Barton changed title from ~~Improve keyboard usage for spacebar search menu~~ to Improve keyboard usage for menu search popup

2020-08-26 04:33:58 +02:00

Luckeneder Georg commented

2020-12-18 00:05:19 +01:00

Added subscriber: @Luckeneder

Luckeneder Georg commented

2020-12-18 00:05:19 +01:00

I tried the diff from Jaap, and i can comfirm it works
interface_region_search.c

I tried the diff from Jaap, and i can comfirm it works [interface_region_search.c](https://archive.blender.org/developer/F9515788/interface_region_search.c)

Alex Carter commented

2021-02-03 23:18:57 +01:00

Added subscriber: @AlexCarter

Alex Carter commented

2021-02-03 23:18:57 +01:00

{F9611275}Ok so I took a look into it and found a way that both wraps to the actual bottom of search list (not just the bottom of what is visual) and also does so without a while loop. Line 1004 in interface_template_search_menu.c creates a variable filtered_amount which is the full size of the search array so to the uiSearchItems struct I added an int size and a setter function so now the total size of the search array is stored and accessible to us back in the ui_searchbox_select function.

{[F9611275](https://archive.blender.org/developer/F9611275/ui-search-loop.diff)}Ok so I took a look into it and found a way that both wraps to the actual bottom of search list (not just the bottom of what is visual) and also does so without a while loop. Line 1004 in `interface_template_search_menu.c` creates a variable `filtered_amount` which is the full size of the search array so to the `uiSearchItems` struct I added an int `size` and a setter function so now the total size of the search array is stored and accessible to us back in the `ui_searchbox_select` function.

Yevgeny Makarov commented

2021-11-30 15:02:47 +01:00

Added subscriber: @jenkm

Yevgeny Makarov commented

2021-11-30 15:02:47 +01:00

I don't mind being able to jump to the first/last item, e.g. with the Page Up / Page Down.
But this endless scrolling doesn't look like a good idea.
We already have this issue in menus and enums, when it is hard to stop at the first/last item. It requires increased accuracy and multiple attempts.
A good example is scrolling the enum on mouse hover with ctrl+wheel. It would be much more useful if scrolling stopped at the first/last item.

I'm not even talking about scrolling with a macbook trackpad, the current behavior with endless scrolling is just terrible, it does not allow you to use a quick swipe to scroll to the beginning/end.

Or another example is a preview menu like a Brushes or MatCap, it's just terrible if it's looped, if the previews are similar then you just don't understand when you've reached the end.

I don't mind being able to jump to the first/last item, e.g. with the Page Up / Page Down. But this endless scrolling doesn't look like a good idea. We already have this issue in menus and enums, when it is hard to stop at the first/last item. It requires increased accuracy and multiple attempts. A good example is scrolling the enum on mouse hover with ctrl+wheel. It would be much more useful if scrolling stopped at the first/last item. I'm not even talking about scrolling with a macbook trackpad, the current behavior with endless scrolling is just terrible, it does not allow you to use a quick swipe to scroll to the beginning/end. Or another example is a preview menu like a Brushes or MatCap, it's just terrible if it's looped, if the previews are similar then you just don't understand when you've reached the end.

michael campbell commented

2021-11-30 15:51:12 +01:00

Added subscriber: @3di

michael campbell commented

2021-11-30 15:51:12 +01:00

I think continuous scroll should be OK on the f3 menu because it's a fixed size and so will never go off screen. The reason the continuous scroll is such a problem on shift a menus is because those menus can grow off screen, and because the mouse scroll wheel is not very accurate, it's really tricky to select the offscreen options without accidentally going back to the bottom/top

I think nice additions would be:

page up/down to jump a page at a time
home/end to go to the top or bottom
scroll with middle mouse button + drag (like you can everywhere else in Blender).
scroll bar on the right for fast scrolling.

I think continuous scroll should be OK on the f3 menu because it's a fixed size and so will never go off screen. The reason the continuous scroll is such a problem on shift a menus is because those menus can grow off screen, and because the mouse scroll wheel is not very accurate, it's really tricky to select the offscreen options without accidentally going back to the bottom/top I think nice additions would be: - page up/down to jump a page at a time - home/end to go to the top or bottom - scroll with middle mouse button + drag (like you can everywhere else in Blender). - scroll bar on the right for fast scrolling.

Camilo Villavicencio commented

2022-05-03 00:33:29 +02:00

Added subscriber: @Camilo-Villavicencio

Camilo Villavicencio commented

2022-05-03 00:33:29 +02:00

Hi! I was able to implement a combination of the first two additions Michael listed above.

Now, pressing the Page Up and Page down keys on Windows on the f3 menu will first select the top or bottom list item of the menu respectively. Pressing either button again will then jump up/down a page in the f3 menu.

I've attached a diff with my additions, as well as a short video of the feature in use.

{F13047150}blender_3lzPkau4nh.mp4

Feel free to let me know what you guys think!

Hi! I was able to implement a combination of the first two additions Michael listed above. Now, pressing the Page Up and Page down keys on Windows on the f3 menu will first select the top or bottom list item of the menu respectively. Pressing either button again will then jump up/down a page in the f3 menu. I've attached a diff with my additions, as well as a short video of the feature in use. {[F13047150](https://archive.blender.org/developer/F13047150/menu-page-jumping.diff)}[blender_3lzPkau4nh.mp4](https://archive.blender.org/developer/F13047156/blender_3lzPkau4nh.mp4) Feel free to let me know what you guys think!

Philipp Oeser removed the

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Improve keyboard usage for menu search popup #51087