Référence de la classe castor3d::ListBoxCtrl

#include <CtrlListBox.hpp>

Graphe d'héritage de castor3d::ListBoxCtrl:

Graphe de collaboration de castor3d::ListBoxCtrl:

Fonctions membres publiques
C3D_API	ListBoxCtrl (SceneRPtr scene, castor::String const &name, ListBoxStyle *style, ControlRPtr parent)
C3D_API	ListBoxCtrl (SceneRPtr scene, castor::String const &name, ListBoxStyle *style, ControlRPtr parent, castor::StringArray const &values, int selected, castor::Position const &position, castor::Size const &size, ControlFlagType flags=0, bool visible=true)
template<size_t N>
	ListBoxCtrl (SceneRPtr scene, castor::String const &name, ListBoxStyle *style, ControlRPtr parent, castor::String const(&values)[N], int selected, castor::Position const &position, castor::Size const &size, ControlFlagType flags=0, bool visible=true)
C3D_API	~ListBoxCtrl () noexcept override
C3D_API void	appendItem (castor::String const &value)
C3D_API void	removeItem (int index)
C3D_API void	setItemText (int index, castor::String const &text)
C3D_API castor::String	getItemText (int index)
C3D_API void	clear ()
C3D_API void	setSelected (int index)
castor::StringArray const &	getItems () const noexcept
uint32_t	getItemCount () const noexcept
int	getSelected () const noexcept
OnListEventConnection	connect (ListBoxEvent event, OnListEventFunction function)
ListBoxStyle const &	getStyle () const noexcept
Fonctions membres publiques hérités de castor3d::Control
C3D_API	Control (ControlType type, SceneRPtr scene, castor::String const &name, ControlStyleRPtr style, ControlRPtr parent, castor::Position const &position, castor::Size const &size, ControlFlagType flags=0, bool visible=true)
C3D_API	~Control () noexcept override
C3D_API void	setStyle (ControlStyleRPtr value)
C3D_API void	setPosition (castor::Position const &value)
C3D_API void	setSize (castor::Size const &value)
C3D_API void	setUV (castor::Point4d const &value)
C3D_API void	setBorderSize (castor::Point4ui const &value)
C3D_API void	setBorderInnerUV (castor::Point4d const &value)
C3D_API void	setBorderOuterUV (castor::Point4d const &value)
C3D_API void	setCaption (castor::U32String const &caption)
C3D_API void	setVisible (bool value)
C3D_API castor::Position	getAbsolutePosition () const
C3D_API bool	isVisible () const
C3D_API bool	isBackgroundInvisible () const
C3D_API ControlRPtr	getChildControl (ControlID id) const
C3D_API std::array< bool, 4u >	isInResizeRange (castor::Position const &position) const
template<ControlFlagTypeT FlagTypeT>
void	addFlag (FlagTypeT flag)
template<ControlFlagTypeT FlagTypeT>
void	addFlag (castor::FlagCombination< FlagTypeT > flag)
template<ControlFlagTypeT FlagTypeT>
void	removeFlag (FlagTypeT flag)
template<ControlFlagTypeT FlagTypeT>
void	removeFlag (castor::FlagCombination< FlagTypeT > flag)
C3D_API castor::Point4d const &	getBorderInnerUV () const
C3D_API castor::Point4d const &	getBorderOuterUV () const
C3D_API BorderPosition	getBorderPosition () const
C3D_API castor::Point4d const &	getUV () const
C3D_API bool	isBackgroundVisible () const
ControlID	getId () const noexcept
ControlType	getType () const noexcept
uint64_t	getFlags () const noexcept
castor::Position const &	getPosition () const noexcept
castor::Size const &	getSize () const noexcept
ControlRPtr	getParent () const noexcept
castor::Point4ui const &	getBorderSize () const noexcept
ControlsManagerRPtr	getControlsManager () const noexcept
MouseCursor	getCursor () const noexcept
Engine &	getEngine () const noexcept
ControlStyle const &	getBaseStyle () const noexcept
std::vector< ControlRPtr > const &	getChildren () const noexcept
bool	hasScene () const noexcept
Scene &	getScene () const noexcept
uint32_t	getResizeBorderSize () const noexcept
castor::Point4ui const &	getClientRect () const noexcept
castor::Position	getClientOffset () const
castor::Size	getClientSize () const
bool	isAlwaysOnTop () const noexcept
bool	isMovable () const noexcept
bool	isResizable () const noexcept
void	show ()
void	hide ()
Fonctions membres publiques hérités de castor3d::NonClientEventHandler< Control >
	NonClientEventHandler (castor::String const &name, bool catchMouseEvents)
	Constructeur.
void	connectNC (MouseEventType event, NonClientMouseFunction function)
	Connecte un fonction à un évènement souris non client.
void	connectNC (KeyboardEventType event, NonClientKeyboardFunction function)
	Connecte un fonction à un évènement clavier non client.
void	connectNC (HandlerEventType event, NonClientHandlerFunction function)
	Connecte un fonction à un évènement gestionnaire non client.
Fonctions membres publiques hérités de castor3d::EventHandler
void	pushEvent (MouseEvent const &event)
	Ajoute un évènement de souris à la file.
void	connect (MouseEventType event, ClientMouseFunction function)
	Connecte un fonction à un évènement souris.
bool	catchesMouseEvents () const
void	setCatchesMouseEvents (bool value)
void	pushEvent (KeyboardEvent const &event)
	Ajoute un évènement de clavier à la file.
void	connect (KeyboardEventType event, ClientKeyboardFunction function)
	Connecte un fonction à un évènement clavier.
bool	catchesTabKey () const
bool	catchesReturnKey () const
	EventHandler (castor::String const &name, bool catchMouseEvents)
	Constructeur.
virtual	~EventHandler ()
	Destructeur.
void	processEvents ()
	Traite tous les évènement dans la file.
bool	isEnabled () const
void	enable ()
void	disable ()
void	pushEvent (HandlerEvent const &event)
	Ajoute un évènement de gestionnaire à la file.
void	connect (HandlerEventType event, ClientHandlerFunction function)
	Connecte un fonction à un évènement gestionnaire.

Attributs publics statiques
static C3D_API ControlType constexpr	Type { ControlType::eListBox }

Membres hérités additionnels
Types publics hérités de castor3d::NonClientEventHandler< Control >
using	DerivedPtr = Control *
using	ClientMouseFunction = EventHandler::ClientMouseFunction
using	ClientKeyboardFunction = EventHandler::ClientKeyboardFunction
using	ClientHandlerFunction = EventHandler::ClientHandlerFunction
using	NonClientMouseFunction = std::function< void(DerivedPtr, MouseEvent const &) >
using	NonClientKeyboardFunction = std::function< void(DerivedPtr, KeyboardEvent const &) >
using	NonClientHandlerFunction = std::function< void(DerivedPtr, HandlerEvent const &) >
using	OnNonClientMouseEvent = castor::SignalT< NonClientMouseFunction >
using	OnNonClientKeyboardEvent = castor::SignalT< NonClientKeyboardFunction >
using	OnNonClientHandlerEvent = castor::SignalT< NonClientHandlerFunction >
using	OnNonClientMouseEventConnection = typename OnNonClientMouseEvent::connection
using	OnNonClientKeyboardEventConnection = typename OnNonClientKeyboardEvent::connection
using	OnNonClientHandlerEventConnection = typename OnNonClientHandlerEvent::connection
Types publics hérités de castor3d::EventHandler
using	ClientMouseFunction = std::function< void(MouseEvent const &) >
using	ClientKeyboardFunction = std::function< void(KeyboardEvent const &) >
using	ClientHandlerFunction = std::function< void(HandlerEvent const &) >
using	EnableFunction = std::function< void(bool) >
using	OnClientMouseEvent = castor::SignalT< ClientMouseFunction >
using	OnClientKeyboardEvent = castor::SignalT< ClientKeyboardFunction >
using	OnClientHandlerEvent = castor::SignalT< ClientHandlerFunction >
using	OnEnable = castor::SignalT< EnableFunction >
using	OnClientMouseEventConnection = OnClientMouseEvent::connection
using	OnClientKeyboardEventConnection = OnClientKeyboardEvent::connection
using	OnClientHandlerEventConnection = OnClientHandlerEvent::connection
using	OnEnableConnection = OnEnable::connection
Attributs publics hérités de castor3d::Control
OnControlChanged	onChanged
Attributs publics hérités de castor3d::EventHandler
OnEnable	onEnable
Types protégés hérités de castor3d::NonClientEventHandler< Control >
using	EventHandlerFunction = EventHandler::EventHandlerFunction
using	EventQueue = EventHandler::EventQueue
Types protégés hérités de castor3d::EventHandler
using	EventHandlerFunction = std::function< void() >
using	EventQueue = std::deque< std::pair< UserInputEventSPtr, EventHandlerFunction > >
Fonctions membres protégées hérités de castor3d::Control
C3D_API Overlay &	getBackgroundOverlay ()
C3D_API void	setBackgroundMaterial (MaterialObs value)
C3D_API void	setBackgroundSize (castor::Size const &value)
C3D_API void	setBackgroundBorderPosition (BorderPosition value)
C3D_API void	setBackgroundBorderMaterial (MaterialObs value)
C3D_API void	create (ControlsManager &ctrlManager)
C3D_API void	destroy ()
C3D_API void	addChild (ControlRPtr control)
C3D_API void	removeChild (ControlRPtr control)
ControlStyle &	getBaseStyle ()
Fonctions membres protégées hérités de castor3d::EventHandler
void	processMouseEvent (MouseEventSPtr event)
	Fonction de traitement d'un évènement souris.
void	processKeyboardEvent (KeyboardEventSPtr event)
	Fonction de traitement d'un évènement clavier.
void	processHandlerEvent (HandlerEventSPtr event)
	Fonction de traitement d'un évènement de gestionnaire.
Attributs protégés hérités de castor3d::Control
SceneRPtr	m_scene {}
ControlRPtr	m_parent {}
	The parent control, if any.
MaterialObs	m_backgroundMaterial {}
	The background material.
MaterialObs	m_foregroundMaterial {}
	The foreground material.
ControlFlagType	m_flags {}
	The control flgas.
Attributs protégés hérités de castor3d::NonClientEventHandler< Control >
std::array< OnNonClientMouseEvent, size_t(MouseEventType::eCount) >	m_ncMouseSlots
std::array< std::vector< OnNonClientMouseEventConnection >, size_t(MouseEventType::eCount) >	m_ncMouseSlotsConnections
std::array< OnNonClientKeyboardEvent, size_t(KeyboardEventType::eCount) >	m_ncKeyboardSlots
std::array< std::vector< OnNonClientKeyboardEventConnection >, size_t(KeyboardEventType::eCount) >	m_ncKeyboardSlotsConnections
std::array< OnNonClientHandlerEvent, size_t(HandlerEventType::eCount) >	m_ncHandlerSlots
std::array< std::vector< OnNonClientHandlerEventConnection >, size_t(HandlerEventType::eCount) >	m_ncHandlerSlotsConnections
Attributs protégés hérités de castor3d::EventHandler
std::array< OnClientMouseEvent, size_t(MouseEventType::eCount) >	m_mouseSlots
std::array< std::vector< OnClientMouseEventConnection >, size_t(MouseEventType::eCount) >	m_mouseSlotsConnections
std::array< OnClientKeyboardEvent, size_t(KeyboardEventType::eCount) >	m_keyboardSlots
std::array< std::vector< OnClientKeyboardEventConnection >, size_t(KeyboardEventType::eCount) >	m_keyboardSlotsConnections
std::array< OnClientHandlerEvent, size_t(HandlerEventType::eCount) >	m_handlerSlots
std::array< std::vector< OnClientHandlerEventConnection >, size_t(HandlerEventType::eCount) >	m_handlerSlotsConnections

Documentation des constructeurs et destructeur

ListBoxCtrl() [1/3]

C3D_API castor3d::ListBoxCtrl::ListBoxCtrl	(	SceneRPtr	scene,
		castor::String const &	name,
		ListBoxStyle *	style,
		ControlRPtr	parent
	)

Constructor

Paramètres

[in]	scene	The parent scene (nullptr for global).
[in]	name	The control name.
[in]	style	The control style.
[in]	parent	The parent control, if any.

ListBoxCtrl() [2/3]

C3D_API castor3d::ListBoxCtrl::ListBoxCtrl	(	SceneRPtr	scene,
		castor::String const &	name,
		ListBoxStyle *	style,
		ControlRPtr	parent,
		castor::StringArray const &	values,
		int	selected,
		castor::Position const &	position,
		castor::Size const &	size,
		ControlFlagType	flags = 0,
		bool	visible = true
	)

Constructor

Paramètres

[in]	scene	The parent scene (nullptr for global).
[in]	name	The control name.
[in]	style	The control style.
[in]	parent	The parent control, if any.
[in]	values	The values list.
[in]	selected	The selected value index (-1 for no selection).
[in]	position	The position.
[in]	size	The size.
[in]	flags	The configuration flags.
[in]	visible	Initial visibility status.

ListBoxCtrl() [3/3]

template<size_t N>

castor3d::ListBoxCtrl::ListBoxCtrl ( SceneRPtr  scene, castor::String const &  name, ListBoxStyle *  style, ControlRPtr  parent, castor::String const(&)  values[N], int  selected, castor::Position const &  position, castor::Size const &  size, ControlFlagType  flags = 0, bool  visible = true  )

inline

Constructor

Paramètres

[in]	scene	The parent scene (nullptr for global).
[in]	name	The control name.
[in]	style	The control style.
[in]	parent	The parent control, if any.
[in]	values	The values list.
[in]	selected	The selected value index (-1 for no selection).
[in]	position	The position.
[in]	size	The size.
[in]	flags	The configuration flags.
[in]	visible	Initial visibility status.

~ListBoxCtrl()

C3D_API castor3d::ListBoxCtrl::~ListBoxCtrl ( )

overridenoexcept

Documentation des fonctions membres

appendItem()

C3D_API void castor3d::ListBoxCtrl::appendItem

(

castor::String const &

value

)

Appends a new item

Paramètres

[in]

value

The item

clear()

C3D_API void castor3d::ListBoxCtrl::clear

(

)

Clears the items

connect()

OnListEventConnection castor3d::ListBoxCtrl::connect ( ListBoxEvent  event, OnListEventFunction  function  )

inline

Connects a function to a listbox event

Paramètres

[in]	event	The event type
[in]	function	The function

Renvoie

The internal function index, to be able to disconnect it

getItemCount()

uint32_t castor3d::ListBoxCtrl::getItemCount ( ) const

inlinenoexcept

Renvoie

The items count.

getItems()

castor::StringArray const & castor3d::ListBoxCtrl::getItems ( ) const

inlinenoexcept

Renvoie

The items.

getItemText()

C3D_API castor::String castor3d::ListBoxCtrl::getItemText

(

int

index

)

Retrieves an item text

Paramètres

[in]

index

The item index

Renvoie

The item text

getSelected()

int castor3d::ListBoxCtrl::getSelected ( ) const

inlinenoexcept

Renvoie

The selected item index.

getStyle()

ListBoxStyle const & castor3d::ListBoxCtrl::getStyle ( ) const

inlinenoexcept

Renvoie

The listbox style.

Références castor3d::Control::getBaseStyle().

Voici le graphe d'appel pour cette fonction :

removeItem()

C3D_API void castor3d::ListBoxCtrl::removeItem

(

int

index

)

Removes an item

Paramètres

[in]

index

The item index

setItemText()

C3D_API void castor3d::ListBoxCtrl::setItemText	(	int	index,
		castor::String const &	text
	)

sets an item text

Paramètres

[in]	index	The item index
[in]	text	The item text

setSelected()

C3D_API void castor3d::ListBoxCtrl::setSelected

(

int

index

)

Sets the selected item

Paramètres

[in]

index

The new value

Documentation des données membres

Type

C3D_API ControlType constexpr castor3d::ListBoxCtrl::Type { ControlType::eListBox }

staticconstexpr

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Gui/Controls/CtrlListBox.hpp