Kanzi  3.9.6
Kanzi Engine API
kanzi::ToggleButtonGroupConcept Class Reference

Use a Toggle Button Group to control a collection of Toggle Buttons so that only one Toggle Button can be toggled on at a time. More...

#include <kanzi/ui/node/concept/toggle_button_group.hpp>

Inheritance diagram for kanzi::ToggleButtonGroupConcept:
[legend]

Classes

class  ToggleButtonGroupConceptMessageArguments
 
class  ToggledMessageArguments
 

Public Attributes

unsigned int m_nextFreeId
 

Static Public Attributes

static MessageType< ToggledMessageArgumentsToggledMessage
 
Properties
static PropertyType< int > CurrentButtonIndexProperty
 Reports the index of the Toggle Button that is toggled on. More...
 

Static Protected Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Detailed Description

Use a Toggle Button Group to control a collection of Toggle Buttons so that only one Toggle Button can be toggled on at a time.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ToggleButtonGroupConcept::makeEditorInfo ( )
staticprotected

Member Data Documentation

◆ m_nextFreeId

unsigned int kanzi::ToggleButtonGroupConcept::m_nextFreeId

◆ CurrentButtonIndexProperty

PropertyType<int> kanzi::ToggleButtonGroupConcept::CurrentButtonIndexProperty
static

Reports the index of the Toggle Button that is toggled on.

The default value is 0. You can use this property in a TwoWayBinding or ToSourceBinding to set which Toggle Button in a Toggle Button Group is currently toggled on. When the toggled state of a Toggle Button in a Toggle Button Group changes, Kanzi internally overrides any one-way binding that targets this property.

See also
ToggleButtonGroupConceptImpl::setCurrentButtonIndex(), ToggleButtonGroupConceptImpl::getCurrentButtonIndex()

◆ ToggledMessage

MessageType<ToggledMessageArguments> kanzi::ToggleButtonGroupConcept::ToggledMessage
static

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