FocusTraverser Class Reference

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

Inheritance diagram for FocusTraverser:

Public Types
enum class	SkipDisabledComponents { no , yes }
	Controls whether the FocusTraverser will allow navigation to disabled components. More...

Public Member Functions
	FocusTraverser ()=default
	Creates a FocusTraverser that will not skip disabled components.
	FocusTraverser (SkipDisabledComponents skipDisabledComponents)
	Creates a FocusTraverser.
	~FocusTraverser () override=default
	Destructor.
Component *	getDefaultComponent (Component *parentComponent) override
	Returns the component that should receive focus by default within the given parent component.
Component *	getNextComponent (Component *current) override
	Returns the component that should be given focus after the specified one when moving "forwards".
Component *	getPreviousComponent (Component *current) override
	Returns the component that should be given focus after the specified one when moving "backwards".
std::vector< Component * >	getAllComponents (Component *parentComponent) override
	Returns all of the components that can receive focus within the given parent component in traversal order.
Public Member Functions inherited from ComponentTraverser
virtual	~ComponentTraverser ()=default
	Destructor.

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:

• Only visible and enabled components are considered focusable.
• If two components both have an explicit focus order specified then the one with the lowest number comes first (see the Component::setExplicitFocusOrder() method).
• Any component with an explicit focus order greater than 0 comes before ones that don't have an order specified.
• Components with their 'always on top' flag set come before those without.
• Any unspecified components are traversed in a left-to-right, then top-to-bottom order.

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

Member Enumeration Documentation

SkipDisabledComponents

enum class FocusTraverser::SkipDisabledComponents

strong

Controls whether the FocusTraverser will allow navigation to disabled components.

Enumerator
no	Disabled components can receive focus.
yes	Disabled components can't receive focus.

Constructor & Destructor Documentation

FocusTraverser() [1/2]

FocusTraverser::FocusTraverser ( )

default

Creates a FocusTraverser that will not skip disabled components.

FocusTraverser() [2/2]

FocusTraverser::FocusTraverser ( SkipDisabledComponents skipDisabledComponents )

explicit

Creates a FocusTraverser.

Parameters

skipDisabledComponents

If set to SkipDisabledComponents::yes, the traverser will ignore disabled components. This makes such components non-discoverable using screen readers.

~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.

References Component.

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.

References Component.

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.

References Component.

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.

References Component, and no.