Allows for finer control of widget focus/tab key ordering.
More...
#include <hdicoreTabOrder.h>
|
|
typedef std::list< std::shared_ptr< Widget > > | WidgetList |
| |
|
| virtual bool | operator== (const TabOrder &rhs_) const |
| | Tests whether a given TabOrder object is the same as another.
|
| |
| virtual bool | operator!= (const TabOrder &rhs_) const |
| | Tests whether a given TabOrder object is not the same as another.
|
| |
| virtual bool | hasWidget (const Widget &widget_) const |
| | Checks whether the target TabOrder object already contains a given widget.
|
| |
| virtual const WidgetList | widgets () const |
| | Gets the list of widgets affected by the target TabOrder object.
|
| |
| virtual std::shared_ptr< Widget > | front () const |
| | Gets the Widget object that is at the front of the target TabOrder object.
|
| |
| virtual void | pushFront (const Widget &widget_) |
| | Pushes a new Widget object on the front of the list for the target TabOrder.
|
| |
| virtual bool | popFront (std::unique_ptr< Widget > &widget__) |
| | Gets the Widget at the front of the target TabOrder, and pops it.
|
| |
| virtual std::shared_ptr< Widget > | back () const |
| | Gets the Widget object that is at the back of the target TabOrder object.
|
| |
| virtual void | pushBack (const Widget &widget_) |
| | Pushes a new Widget object on the back of the list for the target TabOrder.
|
| |
| virtual bool | popBack (std::unique_ptr< Widget > &widget__) |
| | Gets the Widget at the back of the target TabOrder, and pops it.
|
| |
| virtual void | focusNext (const Widget &position_) |
| | Focuses the next (enabled) widget after the one provided.
|
| |
| virtual void | focusPrevious (const Widget &position_) |
| | Focuses the previous (enabled) widget before the one provided.
|
| |
| bool | fireValueChangedIfOnlyOneAvailable () const |
| | Gets whether the target TabOrder object should fire a value-changed callback on a widget if a) the user presses tab, b) the currently focused widget is the only one than can be focused in the group, and c) the currently focused widget support value-changed events.
|
| |
| void | setFireValueChangedIfOnlyOneAvailable (const bool fire_) |
| | Sets whether the target TabOrder object should fire a value-changed callback on a widget if a) the user presses tab, b) the currently focused widget is the only one than can be focused in the group, and c) the currently focused widget support value-changed events.
|
| |
Allows for finer control of widget focus/tab key ordering.
◆ back()
| virtual std::shared_ptr< Widget > hdi::core::TabOrder::back |
( |
| ) |
const |
|
virtual |
Gets the Widget object that is at the back of the target TabOrder object.
- Author
- GW
- Date
- 09/2013
- Returns
- The backmost Widget object, or NULL if none
◆ fireValueChangedIfOnlyOneAvailable()
| bool hdi::core::TabOrder::fireValueChangedIfOnlyOneAvailable |
( |
| ) |
const |
Gets whether the target TabOrder object should fire a value-changed callback on a widget if a) the user presses tab, b) the currently focused widget is the only one than can be focused in the group, and c) the currently focused widget support value-changed events.
- Author
- GW
- Date
- 04/2023
- Returns
- true if the target should fire value-changed callbacks in the above condition
- Note
- The default for all new TabOrder objects is true
◆ focusNext()
| virtual void hdi::core::TabOrder::focusNext |
( |
const Widget & |
position_ | ) |
|
|
virtual |
Focuses the next (enabled) widget after the one provided.
- Author
- GW
- Date
- 09/2013
- Parameters
-
| position_ | Widget immediately before the one that should be focused (typically, the currently focused widget is passed) |
◆ focusPrevious()
| virtual void hdi::core::TabOrder::focusPrevious |
( |
const Widget & |
position_ | ) |
|
|
virtual |
Focuses the previous (enabled) widget before the one provided.
- Author
- GW
- Date
- 09/2013
- Parameters
-
| position_ | Widget immediately after the one that should be focused (typically, the currently focused widget is passed) |
◆ front()
| virtual std::shared_ptr< Widget > hdi::core::TabOrder::front |
( |
| ) |
const |
|
virtual |
Gets the Widget object that is at the front of the target TabOrder object.
- Author
- GW
- Date
- 09/2013
- Returns
- The frontmost Widget object, or NULL if none
◆ hasWidget()
| virtual bool hdi::core::TabOrder::hasWidget |
( |
const Widget & |
widget_ | ) |
const |
|
virtual |
Checks whether the target TabOrder object already contains a given widget.
- Author
- GW
- Date
- 09/2013
- Parameters
-
| widget_ | The widget to check for existence in the TabOrder object |
- Returns
- true if the target contains the given widget, false otherwise
◆ operator!=()
| virtual bool hdi::core::TabOrder::operator!= |
( |
const TabOrder & |
rhs_ | ) |
const |
|
virtual |
Tests whether a given TabOrder object is not the same as another.
- Author
- GW
- Date
- 09/2013
- Parameters
-
| rhs_ | TabOrder to compare against (righthand side of inequality operator) |
- Returns
- true for the target and rhs_ being different UI widgets, false otherwise
◆ operator==()
| virtual bool hdi::core::TabOrder::operator== |
( |
const TabOrder & |
rhs_ | ) |
const |
|
virtual |
Tests whether a given TabOrder object is the same as another.
- Author
- GW
- Date
- 09/2013
- Parameters
-
| rhs_ | TabOrder to compare against (righthand side of equality operator) |
- Returns
- true for the target and rhs_ being the same UI widget, false otherwise
◆ popBack()
| virtual bool hdi::core::TabOrder::popBack |
( |
std::unique_ptr< Widget > & |
widget__ | ) |
|
|
virtual |
Gets the Widget at the back of the target TabOrder, and pops it.
- Author
- GW
- Date
- 09/2013
- Parameters
-
| widget__ | Return-by-reference for the Widget object at the back |
- Returns
- true if the widget at the back was popped and acquired, false otherwise
◆ popFront()
| virtual bool hdi::core::TabOrder::popFront |
( |
std::unique_ptr< Widget > & |
widget__ | ) |
|
|
virtual |
Gets the Widget at the front of the target TabOrder, and pops it.
- Author
- GW
- Date
- 09/2013
- Parameters
-
| widget__ | Return-by-reference for the frontmost Widget object |
- Returns
- true if the frontmost widget was popped and acquired, false otherwise
◆ pushBack()
| virtual void hdi::core::TabOrder::pushBack |
( |
const Widget & |
widget_ | ) |
|
|
virtual |
Pushes a new Widget object on the back of the list for the target TabOrder.
- Author
- GW
- Date
- 09/2013
- Parameters
-
| widget_ | The widget to add to the back of the tab order |
◆ pushFront()
| virtual void hdi::core::TabOrder::pushFront |
( |
const Widget & |
widget_ | ) |
|
|
virtual |
Pushes a new Widget object on the front of the list for the target TabOrder.
- Author
- GW
- Date
- 09/2013
- Parameters
-
| widget_ | The widget to add to the front of the tab order |
◆ setFireValueChangedIfOnlyOneAvailable()
| void hdi::core::TabOrder::setFireValueChangedIfOnlyOneAvailable |
( |
const bool |
fire_ | ) |
|
Sets whether the target TabOrder object should fire a value-changed callback on a widget if a) the user presses tab, b) the currently focused widget is the only one than can be focused in the group, and c) the currently focused widget support value-changed events.
- Author
- GW
- Date
- 04/2023
- Parameters
-
| fire_ | true if the target should fire value-changed callbacks in the above condition, false otherwise |
- Note
- The default for all new TabOrder objects is true
◆ widgets()
| virtual const WidgetList hdi::core::TabOrder::widgets |
( |
| ) |
const |
|
virtual |
Gets the list of widgets affected by the target TabOrder object.
- Author
- GW
- Date
- 09/2013
- Returns
- A list containing all widgets affected by the tab order
1.9.6