JUCE  v6.1.6 (6.0.8-1114)
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::ComponentTraverser Class Referenceabstract

Base class for traversing components. More...

#include <juce_ComponentTraverser.h>

Inheritance diagram for juce::ComponentTraverser:

Public Member Functions

virtual ~ComponentTraverser ()=default
 Destructor. More...
 
virtual std::vector< Component * > getAllComponents (Component *parentComponent)=0
 Returns all of the traversable components within the given parent component in traversal order. More...
 
virtual ComponentgetDefaultComponent (Component *parentComponent)=0
 Returns the component that should be used as the traversal entry point within the given parent component. More...
 
virtual ComponentgetNextComponent (Component *current)=0
 Returns the component that comes after the specified one when moving "forwards". More...
 
virtual ComponentgetPreviousComponent (Component *current)=0
 Returns the component that comes after the specified one when moving "backwards". More...
 

Detailed Description

Base class for traversing components.

If you need custom focus or keyboard focus traversal for a component you can create a subclass of ComponentTraverser and return it from Component::createFocusTraverser() or Component::createKeyboardFocusTraverser().

See also
Component::createFocusTraverser, Component::createKeyboardFocusTraverser

@tags{GUI}

Constructor & Destructor Documentation

◆ ~ComponentTraverser()

virtual juce::ComponentTraverser::~ComponentTraverser ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getAllComponents()

virtual std::vector<Component*> juce::ComponentTraverser::getAllComponents ( Component parentComponent)
pure virtual

Returns all of the traversable components within the given parent component in traversal order.

Implemented in juce::FocusTraverser, and juce::KeyboardFocusTraverser.

◆ getDefaultComponent()

virtual Component* juce::ComponentTraverser::getDefaultComponent ( Component parentComponent)
pure virtual

Returns the component that should be used as the traversal entry point within the given parent component.

This must return nullptr if there is no default component.

Implemented in juce::FocusTraverser, and juce::KeyboardFocusTraverser.

◆ getNextComponent()

virtual Component* juce::ComponentTraverser::getNextComponent ( Component current)
pure virtual

Returns the component that comes after the specified one when moving "forwards".

This must return nullptr if there is no next component.

Implemented in juce::FocusTraverser, and juce::KeyboardFocusTraverser.

◆ getPreviousComponent()

virtual Component* juce::ComponentTraverser::getPreviousComponent ( Component current)
pure virtual

Returns the component that comes after the specified one when moving "backwards".

This must return nullptr if there is no previous component.

Implemented in juce::FocusTraverser, and juce::KeyboardFocusTraverser.


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