CDropdown XUI Element. More...

#include <XUIDropdown.hpp>

Inheritance diagram for CP_SDK::XUI::XUIDropdown:

[legend]

Collaboration diagram for CP_SDK::XUI::XUIDropdown:

[legend]

Public Types
using	Ptr = std::shared_ptr< XUIDropdown >

Public Types inherited from CP_SDK::XUI::IXUIElement
enum class	ETypeID { ColorInput , Dropdown , FLayout , GLayout , HLayout , HSpacer , IconButton , Image , PrimaryButton , SecondaryButton , Slider , TabControl , Text , TextInput , TextSegmentedControl , Toggle , VLayout , VSpacer , VScrollView , VVList }

Public Member Functions
std::shared_ptr< XUIDropdown >	AsShared ()

virtual _v::UIFieldRef< _u::RectTransform >	RTransform () override

virtual _v::UIFieldRef< _v::CDropdown >	Element ()

	XUIDropdown (CP_SDK_PRIV_TAG_ARG(), std::u16string_view p_Name, const std::vector< std::u16string > &p_Options)

virtual void	BuildUI (_u::Transform *p_Parent) override
	BuildUI for this element into p_Parent transform.

virtual XUIDropdown *	OnReady (_v::CActionRef< _v::CDropdown * > p_Functor) override
	IXUIElement OnReady functor interface.

virtual XUIDropdown *	Bind (std::shared_ptr< XUIDropdown > *p_Target) override
	On ready, bind.

XUIDropdown *	OnValueChanged (_v::Action< int, std::u16string_view > p_Functor, bool p_Add=true) XUI_PROXY_IMPL(_v
	On value changed event.

XUIDropdown *	SetActive (bool p_Active) XUI_PROXY_IMPL(_v
	Set game object active state.

XUIDropdown *	SetInteractable (bool p_Interactable) XUI_PROXY_IMPL(_v
	Set interable.

XUIDropdown *	SetOptions (std::vector< std::u16string > p_Options) XUI_PROXY_IMPL(_v
	Set available options.

XUIDropdown *	SetValue (std::u16string_view p_Value, bool p_Notify=true) XUI_PROXY_IMPL(_v
	Set value.

Static Public Member Functions
static Ptr	Make ()
	Constructor.

static Ptr	Make (const std::vector< std::u16string > &p_Options)
	Constructor.

static Ptr	Make (std::u16string_view p_Name, const std::vector< std::u16string > &p_Options)
	Constructor.

Static Public Attributes
static constexpr ETypeID	TypeID = ETypeID::Dropdown

Additional Inherited Members
Public Attributes inherited from CP_SDK::XUI::IXUIElement
ETypeID	m_TypeID

Protected Member Functions inherited from CP_SDK::XUI::IXUIElement
	IXUIElement (std::u16string_view p_Name, ETypeID p_TypeID)
	Constructor.

virtual	~IXUIElement ()=default
	Destructor.

std::u16string_view	GetInitialName ()
	Get initial name.

Protected Member Functions inherited from CP_SDK::XUI::IXUIElementReady< XUIDropdown, _v::CDropdown >
	IXUIElementReady ()
	Constructor.

virtual	~IXUIElementReady ()=default
	Destructor.

Protected Member Functions inherited from CP_SDK::XUI::IXUIBindable< XUIDropdown >
	IXUIBindable ()
	Constructor.

virtual	~IXUIBindable ()=default
	Destructor.

Protected Attributes inherited from CP_SDK::XUI::IXUIElement
std::u16string	m_InitialName

Detailed Description

CDropdown XUI Element.

Definition at line 11 of file XUIDropdown.hpp.

Member Typedef Documentation

◆ Ptr

using CP_SDK::XUI::XUIDropdown::Ptr = std::shared_ptr<XUIDropdown>

Definition at line 39 of file XUIDropdown.hpp.

Constructor & Destructor Documentation

◆ XUIDropdown()

CP_SDK::XUI::XUIDropdown::XUIDropdown	(	CP_SDK_PRIV_TAG_ARG()	,
		std::u16string_view	p_Name,
		const std::vector< std::u16string > &	p_Options
	)

inline

Definition at line 41 of file XUIDropdown.hpp.

Member Function Documentation

◆ AsShared()

std::shared_ptr< XUIDropdown > CP_SDK::XUI::XUIDropdown::AsShared ( )

inline

Definition at line 26 of file XUIDropdown.hpp.

◆ Bind()

virtual XUIDropdown * CP_SDK::XUI::XUIDropdown::Bind ( std::shared_ptr< XUIDropdown > * p_Target )

inlineoverridevirtual

On ready, bind.

Parameters

p_Target Bind target

Implements CP_SDK::XUI::IXUIBindable< XUIDropdown >.

Definition at line 93 of file XUIDropdown.hpp.

◆ BuildUI()

virtual void CP_SDK::XUI::XUIDropdown::BuildUI ( _u::Transform * p_Parent )

inlineoverridevirtual

BuildUI for this element into p_Parent transform.

Parameters

p_Parent Transform to build UI into

Implements CP_SDK::XUI::IXUIElement.

Definition at line 70 of file XUIDropdown.hpp.

References CP_SDK::XUI::IXUIElement::GetInitialName(), and CP_SDK::ChatPlexSDK::Logger().

Here is the call graph for this function:

◆ Element()

virtual _v::UIFieldRef< _v::CDropdown > CP_SDK::XUI::XUIDropdown::Element ( )

inlinevirtual

Definition at line 32 of file XUIDropdown.hpp.

◆ Make() [1/3]

static Ptr CP_SDK::XUI::XUIDropdown::Make ( )

inlinestatic

Constructor.

Definition at line 50 of file XUIDropdown.hpp.

◆ Make() [2/3]

static Ptr CP_SDK::XUI::XUIDropdown::Make ( const std::vector< std::u16string > & p_Options )

inlinestatic

Constructor.

Definition at line 56 of file XUIDropdown.hpp.

◆ Make() [3/3]

static Ptr CP_SDK::XUI::XUIDropdown::Make	(	std::u16string_view	p_Name,
		const std::vector< std::u16string > &	p_Options
	)

inlinestatic

Constructor.

Parameters

p_Name Element name

Definition at line 62 of file XUIDropdown.hpp.

◆ OnReady()

virtual XUIDropdown * CP_SDK::XUI::XUIDropdown::OnReady ( _v::CActionRef< _v::CDropdown * > p_Functor )

inlineoverridevirtual

IXUIElement OnReady functor interface.

Parameters

p_Functor Functor to add

Implements CP_SDK::XUI::IXUIElementReady< XUIDropdown, _v::CDropdown >.

Definition at line 85 of file XUIDropdown.hpp.

◆ OnValueChanged()

XUIDropdown * CP_SDK::XUI::XUIDropdown::OnValueChanged	(	_v::Action< int, std::u16string_view >	p_Functor,
		bool	p_Add = `true`
	)

inline

On value changed event.

Parameters

p_Functor	Functor to add/remove
p_Add	Should add

Definition at line 103 of file XUIDropdown.hpp.

◆ RTransform()

virtual _v::UIFieldRef< _u::RectTransform > CP_SDK::XUI::XUIDropdown::RTransform ( )

inlineoverridevirtual

Implements CP_SDK::XUI::IXUIElement.

Definition at line 28 of file XUIDropdown.hpp.

◆ SetActive()

XUIDropdown * CP_SDK::XUI::XUIDropdown::SetActive ( bool p_Active )

inline

Set game object active state.

Parameters

p_Active New state

Definition at line 108 of file XUIDropdown.hpp.

◆ SetInteractable()

XUIDropdown * CP_SDK::XUI::XUIDropdown::SetInteractable ( bool p_Interactable )

inline

Set interable.

Parameters

p_Interactable New state

Definition at line 113 of file XUIDropdown.hpp.

◆ SetOptions()

XUIDropdown * CP_SDK::XUI::XUIDropdown::SetOptions ( std::vector< std::u16string > p_Options )

inline

Set available options.

Parameters

p_Options New options list

Definition at line 116 of file XUIDropdown.hpp.

References CP_SDK::UI::Components::CDropdown::SetOptions().

Here is the call graph for this function:

◆ SetValue()

XUIDropdown * CP_SDK::XUI::XUIDropdown::SetValue	(	std::u16string_view	p_Value,
		bool	p_Notify = `true`
	)

inline

Set value.

Parameters

p_Value	New value
p_Notify	Should notify?

Definition at line 120 of file XUIDropdown.hpp.

References CP_SDK::UI::Components::CDropdown::SetValue().

Here is the call graph for this function:

Member Data Documentation

◆ TypeID

constexpr ETypeID CP_SDK::XUI::XUIDropdown::TypeID = ETypeID::Dropdown

staticconstexpr

Definition at line 38 of file XUIDropdown.hpp.

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

shared/CP_SDK/XUI/XUIDropdown.hpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ XUIDropdown()

Member Function Documentation

◆ AsShared()

◆ Bind()

◆ BuildUI()

◆ Element()

◆ Make() [1/3]

◆ Make() [2/3]

◆ Make() [3/3]

◆ OnReady()

◆ OnValueChanged()

◆ RTransform()

◆ SetActive()

◆ SetInteractable()

◆ SetOptions()

◆ SetValue()

Member Data Documentation

◆ TypeID