Add keyboard navigation to Ribbon (PR #27046)
Blake-Madden
Supports navigating between tabs, as well as their buttons, toolbars, and galleries.
There are new public implementation functions, but I didn't document them as they seem more like internal functions that client don't really need to see.
Tested on MSW, macOS, and Linux Mint.
You can view, comment on, or merge this pull request online at:
https://github.com/wxWidgets/wxWidgets/pull/27046
Commit Summary
- c33455a Add keyboard navigation to ribbon button bar (tabs and buttons)
- a7de985 Add keyboard navigation to ribbon panel
- 6275a0e Add ribbon toolbar keyboard navigation
- 71494f3 Add keyboard navigation to ribbon gallery
- 065d774 Handle tabbing in/out when not inside of navigation supporting parent
- 2ab4d01 Document ribbon keyboard navigation
File Changes
(13 files)
- M include/wx/ribbon/bar.h (45)
- M include/wx/ribbon/buttonbar.h (11)
- M include/wx/ribbon/control.h (27)
- M include/wx/ribbon/gallery.h (19)
- M include/wx/ribbon/panel.h (18)
- M include/wx/ribbon/toolbar.h (12)
- M interface/wx/ribbon/bar.h (12)
- M src/ribbon/bar.cpp (584)
- M src/ribbon/buttonbar.cpp (112)
- M src/ribbon/control.cpp (49)
- M src/ribbon/gallery.cpp (259)
- M src/ribbon/panel.cpp (173)
- M src/ribbon/toolbar.cpp (112)
Patch Links:
- https://github.com/wxWidgets/wxWidgets/pull/27046.patch
- https://github.com/wxWidgets/wxWidgets/pull/27046.diff
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
VZ
@vadz approved this pull request.
Thanks!
There is a lot of new code here and it's a bit surprising that it seems to be completely independent of all the existing code supporting keyboard navigation (e.g. shouldn't wxWindow::DoNavigateIn() be overridden somewhere?) but, as with the PR adding accelerators display, this is clearly valuable for the users, so let's merge it if nobody sees any problems with it (I'll leave it unmerged for a couple of days to give people a chance to comment).
> @@ -263,6 +303,11 @@ class WXDLLIMPEXP_RIBBON wxRibbonBar : public wxRibbonControl
wxVector<wxImageList*> m_image_lists;
+ // The control whose item has the keyboard focus, null if it's on the tabs.
+ wxWeakRef<wxRibbonControl> m_focusedStop;
Why is it called "stop"?
In include/wx/ribbon/control.h:
> @@ -62,6 +64,31 @@ class WXDLLIMPEXP_RIBBON wxRibbonControl : public wxControl
// Finds the best width and height given the parent's width and height
virtual wxSize GetBestSizeForParentSize(const wxSize& WXUNUSED(parentSize)) const { return GetBestSize(); }
+ // Implementation only: keyboard navigation of the items inside a control.
+ //
+ // The keyboard focus always stays on wxRibbonBar, which forwards the keys
+ // to these functions. A control with items which can be selected with the
+ // keyboard returns true from HasFocusableItems() and overrides the rest.
+ virtual bool HasFocusableItems() const { return false; }
Is this really different from wxWindow::CanAcceptFocus()?
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
Blake-Madden
@Blake-Madden commented on this pull request.
> @@ -263,6 +303,11 @@ class WXDLLIMPEXP_RIBBON wxRibbonBar : public wxRibbonControl
wxVector<wxImageList*> m_image_lists;
+ // The control whose item has the keyboard focus, null if it's on the tabs.
+ wxWeakRef<wxRibbonControl> m_focusedStop;
Yes, "control" or "item" is a better name. I was thinking that as you tab or arrow, it "stops" on that control. I'll reword that...
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
Blake-Madden
@Blake-Madden commented on this pull request.
In include/wx/ribbon/control.h:
> @@ -62,6 +64,31 @@ class WXDLLIMPEXP_RIBBON wxRibbonControl : public wxControl
// Finds the best width and height given the parent's width and height
virtual wxSize GetBestSizeForParentSize(const wxSize& WXUNUSED(parentSize)) const { return GetBestSize(); }
+ // Implementation only: keyboard navigation of the items inside a control.
+ //
+ // The keyboard focus always stays on wxRibbonBar, which forwards the keys
+ // to these functions. A control with items which can be selected with the
+ // keyboard returns true from HasFocusableItems() and overrides the rest.
+ virtual bool HasFocusableItems() const { return false; }
I was thinking CanAcceptFocus() is about if the window itself can receive the focus. Here, the ribbon bar always keeps the focus. This checks if the control has any item the bar can move the focus to. (For example, a button bar with all buttons disabled has none.) I'm updating the comment.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
Blake-Madden
@Blake-Madden pushed 1 commit.
- bf5e428 Fix confusing var names, improve comment
—
View it on GitHub or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
VZ
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.