Controls the order in which keyboard focus moves between components. More...
#include "juce_KeyboardFocusTraverser.h"
Public Member Functions | |
| ~KeyboardFocusTraverser () override=default | |
| Destructor. | |
| Component * | getDefaultComponent (Component *parentComponent) override |
| Returns the component that should receive keyboard focus by default within the given parent component. | |
| Component * | getNextComponent (Component *current) override |
| Returns the component that should be given keyboard focus after the specified one when moving "forwards". | |
| Component * | getPreviousComponent (Component *current) override |
| Returns the component that should be given keyboard focus after the specified one when moving "backwards". | |
| std::vector< Component * > | getAllComponents (Component *parentComponent) override |
| Returns all of the components that can receive keyboard focus within the given parent component in traversal order. | |
 Public Member Functions inherited from juce::ComponentTraverser | |
| virtual | ~ComponentTraverser ()=default |
| Destructor. | |
Detailed Description
Controls the order in which keyboard focus moves between components.
The default behaviour of this class uses a FocusTraverser object internally to determine the default/next/previous component until it finds one which wants keyboard focus, as set by the Component::setWantsKeyboardFocus() method.
If you need keyboard focus traversal in a more customised way, you can create a subclass of ComponentTraverser that uses your own algorithm, and use Component::createKeyboardFocusTraverser() to create it.
@tags{GUI}
Definition at line 45 of file juce_KeyboardFocusTraverser.h.
Member Function Documentation
◆ getAllComponents()
|
overridevirtual |
Returns all of the components that can receive keyboard focus within the given parent component in traversal order.
The default implementation will return all focusable child components (as determined by FocusTraverser) that also wants keyboard focus.
Implements juce::ComponentTraverser.
Reimplemented in juce::LabelKeyboardFocusTraverser.
Definition at line 74 of file juce_KeyboardFocusTraverser.cpp.
◆ getDefaultComponent()
|
overridevirtual |
Returns the component that should receive keyboard focus by default within the given parent component.
The default implementation will return the foremost focusable component (as determined by FocusTraverser) that also wants keyboard focus, or nullptr if there is no suitable component.
Implements juce::ComponentTraverser.
Reimplemented in juce::LabelKeyboardFocusTraverser.
Definition at line 65 of file juce_KeyboardFocusTraverser.cpp.
◆ getNextComponent()
Returns the component that should be given keyboard focus after the specified one when moving "forwards".
The default implementation will return the next focusable component (as determined by FocusTraverser) that also wants keyboard focus, or nullptr if there is no suitable component.
Implements juce::ComponentTraverser.
Reimplemented in juce::LabelKeyboardFocusTraverser.
Definition at line 53 of file juce_KeyboardFocusTraverser.cpp.
◆ getPreviousComponent()
|
overridevirtual |
Returns the component that should be given keyboard focus after the specified one when moving "backwards".
The default implementation will return the previous focusable component (as determined by FocusTraverser) that also wants keyboard focus, or nullptr if there is no suitable component.
Implements juce::ComponentTraverser.
Reimplemented in juce::LabelKeyboardFocusTraverser.
Definition at line 59 of file juce_KeyboardFocusTraverser.cpp.
The documentation for this class was generated from the following files:
- juce_gui_basics/keyboard/juce_KeyboardFocusTraverser.h
- juce_gui_basics/keyboard/juce_KeyboardFocusTraverser.cpp