GUI select box controller. More...

#include <tdme/gui/elements/GUISelectBoxController.h>

Inheritance diagram for GUISelectBoxController:

Collaboration diagram for GUISelectBoxController:

Public Member Functions
void	toggleOpenState (GUIElementNode *optionElementNode)
	Toggle open state of current parent option. More...

void	initialize () override
	Initialize controller after element has been created. More...

void	dispose () override
	Dispose controller. More...

void	postLayout () override
	Post layout event. More...

void	handleMouseEvent (GUINode node, GUIMouseEvent event) override
	Handle mouse event. More...

void	handleKeyboardEvent (GUIKeyboardEvent *event) override
	Handle keyboard event. More...

void	tick () override
	Tick method will be executed once per frame. More...

void	onFocusGained () override
	On focus gained. More...

void	onFocusLost () override
	On focus lost. More...

bool	hasValue () override

const MutableString &	getValue () override

void	setValue (const MutableString &value) override
	Set value. More...

void	onSubTreeChange () override
	On sub tree change. More...

void	determineExpandedParentOptionValues (vector< string > &expandedParentOptionValues)
	Determine expanded parent option values. More...

void	expandParentOptionsByValues (const vector< string > &expandedParentOptionValues)
	Expand parent options by values. More...

Public Member Functions inherited from GUIElementController
bool	isDisabled () override

void	setDisabled (bool disabled) override
	Set disabled. More...

void	initialize () override
	Initialize controller after element has been created. More...

void	dispose () override
	Dispose controller. More...

void	postLayout () override
	Post layout event. More...

void	handleMouseEvent (GUINode node, GUIMouseEvent event) override
	Handle mouse event. More...

void	handleKeyboardEvent (GUIKeyboardEvent *event) override
	Handle keyboard event. More...

void	tick () override
	Tick method will be executed once per frame. More...

void	onFocusGained () override
	On focus gained. More...

void	onFocusLost () override
	On focus lost. More...

bool	hasValue () override

const MutableString &	getValue () override

void	setValue (const MutableString &value) override
	Set value. More...

void	onSubTreeChange () override
	On sub tree change. More...

Public Member Functions inherited from GUINodeController
virtual	~GUINodeController ()
	Destructor. More...

virtual GUINode *	getNode ()

virtual void	initialize ()=0
	Initialize controller after element has been created. More...

virtual void	dispose ()=0
	Dispose controller. More...

virtual void	postLayout ()=0
	Post layout event. More...

virtual void	handleMouseEvent (GUINode node, GUIMouseEvent event)=0
	Handle mouse event. More...

virtual void	handleKeyboardEvent (GUIKeyboardEvent *event)=0
	Handle keyboard event. More...

virtual void	tick ()=0
	Tick method will be executed once per frame. More...

virtual void	onFocusGained ()=0
	On focus gained. More...

virtual void	onFocusLost ()=0
	On focus lost. More...

virtual bool	hasValue ()=0

virtual const MutableString &	getValue ()=0

virtual void	setValue (const MutableString &value)=0
	Set value. More...

virtual bool	isDisabled ()=0

virtual void	setDisabled (bool disabled)=0
	Set disabled. More...

virtual void	onSubTreeChange ()=0
	On sub tree change. More...

Private Member Functions
	GUISelectBoxController (GUINode *node)
	Private constructor. More...

bool	isMultipleSelection ()

bool	isKeyControlDown ()

int	getFocussedOptionIdx ()
	Get focussed option idx. More...

int	getOptionIdx (GUIElementNode *optionElementNode)
	Get focussed option idx. More...

void	unselect ()
	Unselect all nodes. More...

void	select (int optionIdx)
	Select. More...

void	select (GUIElementNode *optionElementNode)
	Select. More...

void	unfocus ()
	Unfocus all nodes. More...

void	focus (int optionIdx)
	Focus. More...

void	focus (GUIElementNode *optionElementNode)
	Focus. More...

void	selectCurrent ()
	Select current options. More...

void	focusNext ()
	Focus next node. More...

void	focusPrevious ()
	Focus previous. More...

void	toggle (int optionIdx)
	Toggle. More...

void	toggle (GUIElementNode *optionElementNode)
	Toggle. More...

void	select ()
	Select focussed node. More...

void	determineAllOptions ()
	Determine all options. More...

void	determineExpandedOptions ()
	Determine expanded options. More...

void	determineParentOptions ()
	Determine parent options. More...

void	toggleOpenState (int optionIdx)
	Toggle open state of current parent option. More...

void	expand (int optionIdx)
	Expand. More...

void	collapse (int optionIdx)
	Collapse. More...

Private Attributes
vector< GUISelectBoxOptionController * >	selectBoxOptionControllers

bool	disabled

bool	multipleSelection

int	focussedOptionIdx

MutableString	value

MutableString	singleValue

bool	keyControl

Static Private Attributes
static STATIC_DLL_IMPEXT string	CONDITION_DISABLED = "disabled"

static STATIC_DLL_IMPEXT string	CONDITION_ENABLED = "enabled"

static STATIC_DLL_IMPEXT constexpr char	VALUE_DELIMITER { '\|' }

Friends
class	GUISelectBox

class	GUISelectBoxOptionController

Additional Inherited Members
Protected Member Functions inherited from GUIElementController
	GUIElementController (GUINode *node)
	Constructor. More...

Protected Member Functions inherited from GUINodeController
	GUINodeController (GUINode *node)
	Private constructor. More...

Protected Attributes inherited from GUINodeController
GUINode *	node { nullptr }

Static Protected Attributes inherited from GUIElementController
static STATIC_DLL_IMPEXT string	CONDITION_DISABLED = "disabled"

static STATIC_DLL_IMPEXT string	CONDITION_ENABLED = "enabled"

Detailed Description

GUI select box controller.

Author: Andreas Drewke

Version: $Id$

Definition at line 29 of file GUISelectBoxController.h.

Constructor & Destructor Documentation

◆ GUISelectBoxController()

GUISelectBoxController ( GUINode * node )

private

Private constructor.

Parameters

node node

Definition at line 45 of file GUISelectBoxController.cpp.

Member Function Documentation

◆ collapse()

void collapse ( int optionIdx )

private

Collapse.

Parameters

optionIdx option index

Definition at line 269 of file GUISelectBoxController.cpp.

◆ determineAllOptions()

void determineAllOptions ( )

private

Determine all options.

Definition at line 290 of file GUISelectBoxController.cpp.

◆ determineExpandedOptions()

void determineExpandedOptions ( )

private

Determine expanded options.

Definition at line 306 of file GUISelectBoxController.cpp.

◆ determineExpandedParentOptionValues()

void determineExpandedParentOptionValues ( vector< string > & expandedParentOptionValues )

Determine expanded parent option values.

Parameters

expandedParentOptionValues expanded parent option values

Definition at line 509 of file GUISelectBoxController.cpp.

◆ determineParentOptions()

void determineParentOptions ( )

private

Determine parent options.

Definition at line 323 of file GUISelectBoxController.cpp.

◆ dispose()

void dispose ( )

overridevirtual

Dispose controller.

Implements GUINodeController.

Definition at line 83 of file GUISelectBoxController.cpp.

◆ expand()

void expand ( int optionIdx )

private

Expand.

Parameters

optionIdx option index

Definition at line 257 of file GUISelectBoxController.cpp.

◆ expandParentOptionsByValues()

void expandParentOptionsByValues ( const vector< string > & expandedParentOptionValues )

Expand parent options by values.

Parameters

expandedParentOptionValues expanded parent option values

Definition at line 520 of file GUISelectBoxController.cpp.

◆ focus() [1/2]

void focus ( GUIElementNode * optionElementNode )

private

Focus.

Parameters

optionElementNode option element node

Definition at line 159 of file GUISelectBoxController.cpp.

◆ focus() [2/2]

void focus ( int optionIdx )

private

Focus.

Parameters

optionIdx option index

Definition at line 150 of file GUISelectBoxController.cpp.

◆ focusNext()

void focusNext ( )

private

Focus next node.

Definition at line 171 of file GUISelectBoxController.cpp.

◆ focusPrevious()

void focusPrevious ( )

private

Focus previous.

Definition at line 192 of file GUISelectBoxController.cpp.

◆ getFocussedOptionIdx()

int getFocussedOptionIdx ( )

private

Get focussed option idx.

Definition at line 92 of file GUISelectBoxController.cpp.

◆ getOptionIdx()

int getOptionIdx ( GUIElementNode * optionElementNode )

private

Get focussed option idx.

Parameters

optionElementNode option element node

Definition at line 109 of file GUISelectBoxController.cpp.

◆ getValue()

const MutableString & getValue ( )

overridevirtual

Returns: value

Implements GUINodeController.

Definition at line 442 of file GUISelectBoxController.cpp.

◆ handleKeyboardEvent()

void handleKeyboardEvent ( GUIKeyboardEvent * event )

overridevirtual

Handle keyboard event.

Parameters

event event

Implements GUINodeController.

Definition at line 350 of file GUISelectBoxController.cpp.

◆ handleMouseEvent()

void handleMouseEvent	(	GUINode *	node,
		GUIMouseEvent *	event
	)

overridevirtual

Handle mouse event.

Parameters

node	node
event	event

Implements GUINodeController.

Definition at line 339 of file GUISelectBoxController.cpp.

◆ hasValue()

bool hasValue ( )

overridevirtual

Returns: has value

Implements GUINodeController.

Definition at line 437 of file GUISelectBoxController.cpp.

◆ initialize()

void initialize ( )

overridevirtual

Initialize controller after element has been created.

Implements GUINodeController.

Definition at line 62 of file GUISelectBoxController.cpp.

◆ isKeyControlDown()

bool isKeyControlDown ( )

private

Returns: is control down

Definition at line 58 of file GUISelectBoxController.cpp.

◆ isMultipleSelection()

bool isMultipleSelection ( )

private

Returns: if multiple selection is enabled

Definition at line 54 of file GUISelectBoxController.cpp.

◆ onFocusGained()

void onFocusGained ( )

overridevirtual

On focus gained.

Implements GUINodeController.

Definition at line 428 of file GUISelectBoxController.cpp.

◆ onFocusLost()

void onFocusLost ( )

overridevirtual

On focus lost.

Implements GUINodeController.

Definition at line 432 of file GUISelectBoxController.cpp.

◆ onSubTreeChange()

void onSubTreeChange ( )

overridevirtual

On sub tree change.

Implements GUINodeController.

Definition at line 505 of file GUISelectBoxController.cpp.

◆ postLayout()

void postLayout ( )

overridevirtual

Post layout event.

Implements GUINodeController.

Definition at line 88 of file GUISelectBoxController.cpp.

◆ select() [1/3]

void select ( )

private

Select focussed node.

Definition at line 238 of file GUISelectBoxController.cpp.

◆ select() [2/3]

void select ( GUIElementNode * optionElementNode )

private

Select.

Parameters

optionElementNode option element node

Definition at line 137 of file GUISelectBoxController.cpp.

◆ select() [3/3]

void select ( int optionIdx )

private

Select.

Parameters

optionIdx option index

Definition at line 125 of file GUISelectBoxController.cpp.

◆ selectCurrent()

void selectCurrent ( )

private

Select current options.

Definition at line 166 of file GUISelectBoxController.cpp.

◆ setValue()

void setValue ( const MutableString & value )

overridevirtual

Set value.

Parameters

value value

Implements GUINodeController.

Definition at line 454 of file GUISelectBoxController.cpp.

◆ tick()

void tick ( )

overridevirtual

Tick method will be executed once per frame.

Implements GUINodeController.

Definition at line 423 of file GUISelectBoxController.cpp.

◆ toggle() [1/2]

void toggle ( GUIElementNode * optionElementNode )

private

Toggle.

Parameters

optionElementNode option element node

Definition at line 231 of file GUISelectBoxController.cpp.

◆ toggle() [2/2]

void toggle ( int optionIdx )

private

Toggle.

Parameters

optionIdx option index

Definition at line 213 of file GUISelectBoxController.cpp.

◆ toggleOpenState() [1/2]

void toggleOpenState ( GUIElementNode * optionElementNode )

Toggle open state of current parent option.

Parameters

optionElementNode option element node

Definition at line 281 of file GUISelectBoxController.cpp.

◆ toggleOpenState() [2/2]

void toggleOpenState ( int optionIdx )

private

Toggle open state of current parent option.

Parameters

optionIdx option index

Definition at line 247 of file GUISelectBoxController.cpp.

◆ unfocus()

void unfocus ( )

private

Unfocus all nodes.

Definition at line 143 of file GUISelectBoxController.cpp.

◆ unselect()

void unselect ( )

private

Unselect all nodes.

Definition at line 117 of file GUISelectBoxController.cpp.

Friends And Related Function Documentation

◆ GUISelectBox

friend class GUISelectBox

friend

Definition at line 32 of file GUISelectBoxController.h.

◆ GUISelectBoxOptionController

friend class GUISelectBoxOptionController

friend

Definition at line 33 of file GUISelectBoxController.h.

Member Data Documentation

◆ CONDITION_DISABLED

string CONDITION_DISABLED = "disabled"

staticprivate

Definition at line 36 of file GUISelectBoxController.h.

◆ CONDITION_ENABLED

string CONDITION_ENABLED = "enabled"

staticprivate

Definition at line 37 of file GUISelectBoxController.h.

◆ disabled

bool disabled

private

Definition at line 40 of file GUISelectBoxController.h.

◆ focussedOptionIdx

int focussedOptionIdx

private

Definition at line 42 of file GUISelectBoxController.h.

◆ keyControl

bool keyControl

private

Definition at line 46 of file GUISelectBoxController.h.

◆ multipleSelection

bool multipleSelection

private

Definition at line 41 of file GUISelectBoxController.h.

◆ selectBoxOptionControllers

vector<GUISelectBoxOptionController*> selectBoxOptionControllers

private

Definition at line 39 of file GUISelectBoxController.h.

◆ singleValue

MutableString singleValue

private

Definition at line 44 of file GUISelectBoxController.h.

◆ value

MutableString value

private

Definition at line 43 of file GUISelectBoxController.h.

◆ VALUE_DELIMITER

STATIC_DLL_IMPEXT constexpr char VALUE_DELIMITER { '|' }

staticconstexprprivate

Definition at line 38 of file GUISelectBoxController.h.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/gui/elements/GUISelectBoxController.h
/home/andreas/Development/drewke.net/tdme2/src/tdme/gui/elements/GUISelectBoxController.cpp

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GUISelectBoxController()

Member Function Documentation

◆ collapse()

◆ determineAllOptions()

◆ determineExpandedOptions()

◆ determineExpandedParentOptionValues()

◆ determineParentOptions()

◆ dispose()

◆ expand()

◆ expandParentOptionsByValues()

◆ focus() [1/2]

◆ focus() [2/2]

◆ focusNext()

◆ focusPrevious()

◆ getFocussedOptionIdx()

◆ getOptionIdx()

◆ getValue()

◆ handleKeyboardEvent()

◆ handleMouseEvent()

◆ hasValue()

◆ initialize()

◆ isKeyControlDown()

◆ isMultipleSelection()

◆ onFocusGained()

◆ onFocusLost()

◆ onSubTreeChange()

◆ postLayout()

◆ select() [1/3]

◆ select() [2/3]

◆ select() [3/3]

◆ selectCurrent()

◆ setValue()

◆ tick()

◆ toggle() [1/2]

◆ toggle() [2/2]

◆ toggleOpenState() [1/2]

◆ toggleOpenState() [2/2]

◆ unfocus()

◆ unselect()

Friends And Related Function Documentation

◆ GUISelectBox

◆ GUISelectBoxOptionController

Member Data Documentation

◆ CONDITION_DISABLED

◆ CONDITION_ENABLED

◆ disabled

◆ focussedOptionIdx

◆ keyControl

◆ multipleSelection

◆ selectBoxOptionControllers

◆ singleValue

◆ value

◆ VALUE_DELIMITER