Public Member Functions | List of all members
FocusTraverser Class Reference

Controls the order in which focus moves between components. More...

Inheritance diagram for FocusTraverser:

Public Member Functions

 ~FocusTraverser () override=default
 Destructor. More...
 
ComponentgetDefaultComponent (Component *parentComponent) override
 Returns the component that should receive focus by default within the given parent component. More...
 
ComponentgetNextComponent (Component *current) override
 Returns the component that should be given focus after the specified one when moving "forwards". More...
 
ComponentgetPreviousComponent (Component *current) override
 Returns the component that should be given focus after the specified one when moving "backwards". More...
 
std::vector< Component * > getAllComponents (Component *parentComponent) override
 Returns all of the components that can receive focus within the given parent component in traversal order. More...
 
- Public Member Functions inherited from ComponentTraverser
virtual ~ComponentTraverser ()=default
 Destructor. More...
 

Detailed Description

Controls the order in which focus moves between components.

The algorithm used by this class to work out the order of traversal is as follows:

If you need focus traversal in a more customised way you can create a ComponentTraverser subclass that uses your own algorithm and return it from Component::createFocusTraverser().

See also
ComponentTraverser, Component::createFocusTraverser

Constructor & Destructor Documentation

◆ ~FocusTraverser()

FocusTraverser::~FocusTraverser ( )
overridedefault

Destructor.

Member Function Documentation

◆ getDefaultComponent()

Component* FocusTraverser::getDefaultComponent ( Component parentComponent)
overridevirtual

Returns the component that should receive focus by default within the given parent component.

The default implementation will just return the foremost visible and enabled child component, and will return nullptr if there is no suitable component.

Implements ComponentTraverser.

◆ getNextComponent()

Component* FocusTraverser::getNextComponent ( Component current)
overridevirtual

Returns the component that should be given focus after the specified one when moving "forwards".

The default implementation will return the next visible and enabled component which is to the right of or below this one, and will return nullptr if there is no suitable component.

Implements ComponentTraverser.

◆ getPreviousComponent()

Component* FocusTraverser::getPreviousComponent ( Component current)
overridevirtual

Returns the component that should be given focus after the specified one when moving "backwards".

The default implementation will return the previous visible and enabled component which is to the left of or above this one, and will return nullptr if there is no suitable component.

Implements ComponentTraverser.

◆ getAllComponents()

std::vector<Component*> FocusTraverser::getAllComponents ( Component parentComponent)
overridevirtual

Returns all of the components that can receive focus within the given parent component in traversal order.

The default implementation will return all visible and enabled child components.

Implements ComponentTraverser.


The documentation for this class was generated from the following file: