Inheritance diagram for ToggleComponent:

Public Member Functions
virtual ::std::unique_ptr<::UIComponent >	clone (::UIControl &cloneOwner) const
virtual void	reset ()
virtual::ComponentReceiveActionType	receive (::ScreenEvent const &screenEvent)
virtual::ComponentReceiveActionType	receive (::VisualTree &visualTree, ::ScreenInputContext &context, ::UIAnimationController &animationController, ::ScreenEvent const &screenEvent)
virtual::std::string const &	getTextToSpeechComponentValue () const
MCAPI	ToggleComponent (::UIControl &owner)
MCAPI void	_setChecked (::ScreenInputContext &context, bool checked, bool toggledByButtonClick)
MCAPI void	_updateControlVisibility ()
MCAPI void	_updateToggleGroupState (::VisualTree &visualTree, bool toggleState)
MCAPI void	resetDefaultState ()
MCAPI void	setChecked (bool checked)
MCAPI void	setForcedGroupIndex (int forcedIndex)
MCAPI void *	$ctor (::UIControl &owner)
MCAPI ::std::unique_ptr<::UIComponent >	$clone (::UIControl &cloneOwner) const
MCAPI void	$reset ()
MCAPI::ComponentReceiveActionType	$receive (::ScreenEvent const &screenEvent)
MCAPI::ComponentReceiveActionType	$receive (::VisualTree &visualTree, ::ScreenInputContext &context, ::UIAnimationController &animationController, ::ScreenEvent const &screenEvent)
MCAPI::std::string const &	$getTextToSpeechComponentValue () const
virtual void	onNotifyChildAdded ()
virtual void	onNotifyChildRemoved ()
virtual void	onRemoved ()
virtual void	onAdded ()
virtual void	onVisibilityChanged (bool visible)
virtual void	onEnabledChanged (bool enabled)
virtual bool	isRenderableComponent () const
virtual bool	isCustomFrameUpdateComponent () const
virtual bool	onLayoutChange ()
virtual void	reload (::UIComponent const &rhs)
MCAPI void	$onNotifyChildAdded ()
MCAPI void	$onNotifyChildRemoved ()
MCAPI void	$onRemoved ()
MCAPI void	$onAdded ()
MCAPI void	$onVisibilityChanged (bool visible)
MCAPI void	$onEnabledChanged (bool enabled)
MCAPI bool	$isRenderableComponent () const
MCAPI bool	$isCustomFrameUpdateComponent () const
MCAPI bool	$onLayoutChange ()
MCAPI void	$reload (::UIComponent const &rhs)

Public Attributes
::ll::TypedStorage< 8, 16, ::std::weak_ptr<::UIControl > >	mCheckedStateControl
::ll::TypedStorage< 8, 16, ::std::weak_ptr<::UIControl > >	mUncheckedStateControl
::ll::TypedStorage< 8, 16, ::std::weak_ptr<::UIControl > >	mCheckedHoverStateControl
::ll::TypedStorage< 8, 16, ::std::weak_ptr<::UIControl > >	mUncheckedHoverStateControl
::ll::TypedStorage< 8, 16, ::std::weak_ptr<::UIControl > >	mCheckedLockedStateControl
::ll::TypedStorage< 8, 16, ::std::weak_ptr<::UIControl > >	mCheckedLockedHoverStateControl
::ll::TypedStorage< 8, 16, ::std::weak_ptr<::UIControl > >	mUncheckedLockedStateControl
::ll::TypedStorage< 8, 16, ::std::weak_ptr<::UIControl > >	mUncheckedLockedHoverStateControl
bool	mChecked: 1
bool	mHover: 1
bool	mRadioToggleGroup: 1
bool	mDefaultState: 1
bool	mEnableDirectionalToggling: 1
::ll::TypedStorage< 8, 32, ::std::string >	mGridCollectionName
::ll::TypedStorage< 4, 4, uint >	mToggleNameId
::ll::TypedStorage< 4, 4, uint >	mToggleOnButtonId
::ll::TypedStorage< 4, 4, uint >	mToggleOffButtonId
::ll::TypedStorage< 4, 4, int >	mForcedIndex
::ll::TypedStorage< 4, 4, int >	mDefaultGroupSelectedIndex
::ll::TypedStorage< 8, 32, ::std::string >	mTTSValueOn
::ll::TypedStorage< 8, 32, ::std::string >	mTTSValueOff
::ll::TypedStorage< 8, 32, ::std::string >	mDescriptiveText
::ll::TypedStorage< 8, 8, ::UIControl & >	mOwner

Constructor & Destructor Documentation

◆ ToggleComponent()

MCAPI ToggleComponent::ToggleComponent ( ::UIControl & owner )

explicit

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

Member Function Documentation

◆ clone()

virtual ::std::unique_ptr<::UIComponent > ToggleComponent::clone ( ::UIControl & cloneOwner ) const

virtual

Implements UIComponent.

◆ reset()

virtual void ToggleComponent::reset ( )

virtual

Implements UIComponent.

◆ _setChecked()

MCAPI void ToggleComponent::_setChecked	(	::ScreenInputContext &	context,
		bool	checked,
		bool	toggledByButtonClick )

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ _updateControlVisibility()

MCAPI void ToggleComponent::_updateControlVisibility ( )

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ _updateToggleGroupState()

MCAPI void ToggleComponent::_updateToggleGroupState	(	::VisualTree &	visualTree,
		bool	toggleState )

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ resetDefaultState()

MCAPI void ToggleComponent::resetDefaultState ( )

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ setChecked()

MCAPI void ToggleComponent::setChecked ( bool checked )

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ setForcedGroupIndex()

MCAPI void ToggleComponent::setForcedGroupIndex ( int forcedIndex )

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $ctor()

MCAPI void * ToggleComponent::$ctor ( ::UIControl & owner )

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $clone()

MCAPI ::std::unique_ptr<::UIComponent > ToggleComponent::$clone ( ::UIControl & cloneOwner ) const

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $reset()

MCAPI void ToggleComponent::$reset ( )

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $receive() [1/2]

MCAPI::ComponentReceiveActionType ToggleComponent::$receive ( ::ScreenEvent const & screenEvent )

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $receive() [2/2]

MCAPI::ComponentReceiveActionType ToggleComponent::$receive	(	::VisualTree &	visualTree,
		::ScreenInputContext &	context,
		::UIAnimationController &	animationController,
		::ScreenEvent const &	screenEvent )

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $getTextToSpeechComponentValue()

MCAPI::std::string const & ToggleComponent::$getTextToSpeechComponentValue ( ) const

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $onNotifyChildAdded()

MCAPI void UIComponent::$onNotifyChildAdded ( )

inherited

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $onNotifyChildRemoved()

MCAPI void UIComponent::$onNotifyChildRemoved ( )

inherited

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $onRemoved()

MCAPI void UIComponent::$onRemoved ( )

inherited

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $onAdded()

MCAPI void UIComponent::$onAdded ( )

inherited

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $onVisibilityChanged()

MCAPI void UIComponent::$onVisibilityChanged ( bool visible )

inherited

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $onEnabledChanged()

MCAPI void UIComponent::$onEnabledChanged ( bool enabled )

inherited

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $isRenderableComponent()

MCAPI bool UIComponent::$isRenderableComponent ( ) const

inherited

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $isCustomFrameUpdateComponent()

MCAPI bool UIComponent::$isCustomFrameUpdateComponent ( ) const

inherited

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $onLayoutChange()

MCAPI bool UIComponent::$onLayoutChange ( )

inherited

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

◆ $reload()

MCAPI void UIComponent::$reload ( ::UIComponent const & rhs )

inherited

Attention: This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

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

src-server/mc/client/gui/controls/ToggleComponent.h
src-client/mc/client/gui/controls/ToggleComponent.h

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

◆ ToggleComponent()

Member Function Documentation

◆ clone()

◆ reset()

◆ _setChecked()

◆ _updateControlVisibility()

◆ _updateToggleGroupState()

◆ resetDefaultState()

◆ setChecked()

◆ setForcedGroupIndex()

◆ $ctor()

◆ $clone()

◆ $reset()

◆ $receive() [1/2]

◆ $receive() [2/2]

◆ $getTextToSpeechComponentValue()

◆ $onNotifyChildAdded()

◆ $onNotifyChildRemoved()

◆ $onRemoved()

◆ $onAdded()

◆ $onVisibilityChanged()

◆ $onEnabledChanged()

◆ $isRenderableComponent()

◆ $isCustomFrameUpdateComponent()

◆ $onLayoutChange()

◆ $reload()