widget description should be here. More...

#include <MyGUI_ListBox.h>

Inheritance diagram for MyGUI::ListBox:

[legend]

Public Types
typedef RTTIBase	Base

typedef ListBox	RTTIBase

Public Types inherited from MyGUI::Widget
typedef RTTIBase	Base

typedef Widget	RTTIBase

Public Types inherited from MyGUI::IObject
typedef IObject	RTTIBase

Public Member Functions
virtual std::string_view	getTypeName () const override

virtual bool	isType (const std::type_info &_type) const override

template<typename Type >
bool	isType () const

Item Methods.
Methods used to manipulate items.
size_t	getItemCount () const
	Get number of items.

void	insertItemAt (size_t _index, const UString &_name, Any _data=Any::Null)
	Insert an item into a array at a specified position.

void	addItem (const UString &_name, Any _data=Any::Null)
	Add an item to the end of a array.

void	removeItemAt (size_t _index)
	Remove item at a specified position.

void	removeAllItems ()
	Remove all items.

void	swapItemsAt (size_t _index1, size_t _index2)
	Swap items at a specified positions.

size_t	findItemIndexWith (const UString &_name)
	Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found.

Item Selection Methods
Methods used to manipulate item selection.
size_t	getIndexSelected () const

void	setIndexSelected (size_t _index)

void	clearIndexSelected ()

Item Data Methods
Methods used to manipulate item user data.
void	setItemDataAt (size_t _index, Any _data)
	Replace an item data at a specified position.

void	clearItemDataAt (size_t _index)
	Clear an item data at a specified position.

template<typename ValueType >
ValueType *	getItemDataAt (size_t _index, bool _throw=true) const
	Get item data from specified position.

void	setItemNameAt (size_t _index, const UString &_name)
	Replace an item name at a specified position.

const UString &	getItemNameAt (size_t _index) const
	Get item name from specified position.

Item Visibility Methods
Methods used to determine and manipulate item visibility.
void	beginToItemAt (size_t _index)
	Move all elements so specified becomes visible.

void	beginToItemFirst ()
	Move all elements so first becomes visible.

void	beginToItemLast ()
	Move all elements so last becomes visible.

void	beginToItemSelected ()
	Move all elements so selected becomes visible.

bool	isItemVisibleAt (size_t _index, bool _fill=true)

bool	isItemSelectedVisible (bool _fill=true)
	Same as ListBox::isItemVisibleAt for selected item.

void	setScrollVisible (bool _visible)
	Set scroll visible when it needed.

void	setScrollPosition (size_t _position)
	Set scroll position.

Public Member Functions inherited from MyGUI::Widget
template<typename Type >
bool	isType () const

Widget *	createWidgetT (std::string_view _type, std::string_view _skin, const IntCoord &_coord, Align _align, std::string_view _name={})

Widget *	createWidgetT (std::string_view _type, std::string_view _skin, int _left, int _top, int _width, int _height, Align _align, std::string_view _name={})

Widget *	createWidgetRealT (std::string_view _type, std::string_view _skin, const FloatCoord &_coord, Align _align, std::string_view _name={})

Widget *	createWidgetRealT (std::string_view _type, std::string_view _skin, float _left, float _top, float _width, float _height, Align _align, std::string_view _name={})

template<typename T >
T *	createWidget (std::string_view _skin, const IntCoord &_coord, Align _align, std::string_view _name={})

template<typename T >
T *	createWidget (std::string_view _skin, int _left, int _top, int _width, int _height, Align _align, std::string_view _name={})

template<typename T >
T *	createWidgetReal (std::string_view _skin, const FloatCoord &_coord, Align _align, std::string_view _name={})

template<typename T >
T *	createWidgetReal (std::string_view _skin, float _left, float _top, float _width, float _height, Align _align, std::string_view _name={})

Widget *	createWidgetT (WidgetStyle _style, std::string_view _type, std::string_view _skin, const IntCoord &_coord, Align _align, std::string_view _layer={}, std::string_view _name={})

template<typename T >
T *	createWidget (WidgetStyle _style, std::string_view _skin, const IntCoord &_coord, Align _align, std::string_view _layer={}, std::string_view _name={})

void	setPosition (const IntPoint &_point) override

void	setSize (const IntSize &_size) override

void	setCoord (const IntCoord &_coord) override

void	setPosition (int _left, int _top)

void	setSize (int _width, int _height)

void	setCoord (int _left, int _top, int _width, int _height)

void	setRealPosition (const FloatPoint &_point)

void	setRealSize (const FloatSize &_size)

void	setRealCoord (const FloatCoord &_coord)

void	setRealPosition (float _left, float _top)

void	setRealSize (float _width, float _height)

void	setRealCoord (float _left, float _top, float _width, float _height)

const std::string &	getName () const
	Get name of widget.

virtual void	setVisible (bool _value)

bool	getVisible () const

void	setDepth (int _value)

int	getDepth () const

bool	getInheritedVisible () const

virtual void	setAlign (Align _value)

Align	getAlign () const

void	setAlpha (float _alpha)

float	getAlpha () const

void	setInheritsAlpha (bool _inherits)

bool	getInheritsAlpha () const

void	setColour (const Colour &_value)

bool	isRootWidget () const

Widget *	getParent () const

IntSize	getParentSize () const

EnumeratorWidgetPtr	getEnumerator () const

size_t	getChildCount () const

Widget *	getChildAt (size_t _index) const

Widget *	findWidget (std::string_view _name)

void	findWidgets (std::string_view _name, VectorWidgetPtr &_result)

virtual void	setEnabled (bool _value)

void	setEnabledSilent (bool _value)

bool	getEnabled () const

bool	getInheritedEnabled () const

IntCoord	getClientCoord () const

Widget *	getClientWidget ()

const Widget *	getClientWidget () const

void	detachFromWidget (std::string_view _layer={})

void	attachToWidget (Widget *_parent, WidgetStyle _style=WidgetStyle::Child, std::string_view _layer={})

void	changeWidgetSkin (std::string_view _skinName)

void	setWidgetStyle (WidgetStyle _style, std::string_view _layer={})

WidgetStyle	getWidgetStyle () const

void	setProperty (std::string_view _key, std::string_view _value)

void	_forcePick (Widget *_widget)

void	_initialise (WidgetStyle _style, const IntCoord &_coord, std::string_view _skinName, Widget _parent, ICroppedRectangle _croppedParent, std::string_view _name)

void	_shutdown ()

void	_destroyChildWidget (Widget *_widget)

void	_setContainer (Widget *_value)

Widget *	_getContainer () const

void	_setAlign (const IntSize &_oldsize, const IntSize &_newSize)

bool	_checkPoint (int _left, int _top) const

Widget *	_createSkinWidget (WidgetStyle _style, std::string_view _type, std::string_view _skin, const IntCoord &_coord, Align _align, std::string_view _layer={}, std::string_view _name={})

bool	_setWidgetState (std::string_view _state)

void	_updateChilds ()

Public Member Functions inherited from MyGUI::IObject
template<typename Type >
bool	isType () const

template<typename Type >
Type *	castType (bool _throw=true)

template<typename Type >
const Type *	castType (bool _throw=true) const

virtual	~IObject ()=default

Public Member Functions inherited from MyGUI::ICroppedRectangle
virtual	~ICroppedRectangle ()=default

ICroppedRectangle *	getCroppedParent ()

IntPoint	getPosition () const

IntSize	getSize () const

const IntCoord &	getCoord () const

const IntPoint &	getAbsolutePosition () const

IntRect	getAbsoluteRect () const

IntCoord	getAbsoluteCoord () const

int	getAbsoluteLeft () const

int	getAbsoluteTop () const

int	getLeft () const

int	getRight () const

int	getTop () const

int	getBottom () const

int	getWidth () const

int	getHeight () const

bool	_isMargin () const

int	_getViewLeft () const

int	_getViewRight () const

int	_getViewTop () const

int	_getViewBottom () const

int	_getViewWidth () const

int	_getViewHeight () const

void	_setCroppedParent (ICroppedRectangle *_parent)

const IntRect &	_getMargin () const

int	_getMarginLeft () const

int	_getMarginRight () const

int	_getMarginTop () const

int	_getMarginBottom () const

Public Member Functions inherited from MyGUI::UserData
virtual	~UserData ()=default

void	setUserString (std::string_view _key, std::string_view _value)

std::string_view	getUserString (std::string_view _key) const

const MapString &	getUserStrings () const

bool	clearUserString (std::string_view _key)

bool	isUserString (std::string_view _key) const

void	clearUserStrings ()

void	setUserData (Any _data)

template<typename ValueType >
ValueType *	getUserData (bool _throw=true) const

void	_setInternalData (Any _data)

template<typename ValueType >
ValueType *	_getInternalData (bool _throw=true) const

Public Member Functions inherited from MyGUI::WidgetInput
virtual	~WidgetInput ()=default

void	setNeedToolTip (bool _value)

bool	getNeedToolTip () const

void	setPointer (std::string_view _value)

const std::string &	getPointer () const

void	setNeedKeyFocus (bool _value)

bool	getNeedKeyFocus () const

void	setNeedMouseFocus (bool _value)

bool	getNeedMouseFocus () const

void	setInheritsPick (bool _value)

bool	getInheritsPick () const

void	setMaskPick (const std::string &_filename)

void	setMaskPick (const MaskPickInfo &_info)

bool	isMaskPickInside (const IntPoint &_point, const IntCoord &_coord) const

bool	getRootMouseFocus () const

bool	getRootKeyFocus () const

void	_riseMouseLostFocus (Widget *_new)

void	_riseMouseSetFocus (Widget *_old)

void	_riseMouseDrag (int _left, int _top, MouseButton _id)

void	_riseMouseMove (int _left, int _top)

void	_riseMouseWheel (int _rel)

void	_riseMouseButtonPressed (int _left, int _top, MouseButton _id)

void	_riseMouseButtonReleased (int _left, int _top, MouseButton _id)

void	_riseMouseButtonClick ()

void	_riseMouseButtonDoubleClick ()

void	_riseKeyLostFocus (Widget *_new)

void	_riseKeySetFocus (Widget *_old)

void	_riseKeyButtonPressed (KeyCode _key, Char _char)

void	_riseKeyButtonReleased (KeyCode _key)

void	_riseMouseChangeRootFocus (bool _focus)

void	_riseKeyChangeRootFocus (bool _focus)

void	_setRootMouseFocus (bool _value)

void	_setRootKeyFocus (bool _value)

Public Member Functions inherited from MyGUI::delegates::IDelegateUnlink
virtual	~IDelegateUnlink ()=default

	IDelegateUnlink ()

bool	compare (IDelegateUnlink *_unlink) const

Public Member Functions inherited from MyGUI::SkinItem
ISubWidgetText *	getSubWidgetText () const

ISubWidgetRect *	getSubWidgetMain () const

void	_setTextureName (std::string_view _texture)

const std::string &	_getTextureName () const

Public Member Functions inherited from MyGUI::LayerItem
ILayer *	getLayer () const

ILayerNode *	getLayerNode () const

void	attachItemToNode (ILayer _layer, ILayerNode _node) override

void	detachFromLayer () override

void	upLayerItem () override

void	setRenderItemTexture (ITexture *_texture)

void	addChildItem (LayerItem *_item)

void	removeChildItem (LayerItem *_item)

void	addChildNode (LayerItem *_item)

void	removeChildNode (LayerItem *_item)

void	addRenderItem (ISubWidget *_item)

void	removeAllRenderItems ()

void	saveLayerItem ()

void	restoreLayerItem ()

Public Member Functions inherited from MyGUI::ILayerItem
virtual	~ILayerItem ()=default

Public Member Functions inherited from MyGUI::MemberObsolete< Widget >
bool	isEnabled ()

bool	isInheritsAlpha ()

bool	isNeedKeyFocus ()

bool	isNeedMouseFocus ()

bool	isInheritsPick ()

bool	isVisible ()

Public Member Functions inherited from MyGUI::IItemContainer
virtual	~IItemContainer ()=default

virtual Widget *	_getItemAt (size_t _index) const

virtual void	_setItemSelected (IItem *)

Public Member Functions inherited from MyGUI::MemberObsolete< ListBox >
size_t	getItemIndexSelected () const

void	setItemSelectedAt (size_t _index)

void	clearItemSelected ()

void	insertItem (size_t _index, const UString &_item)

void	setItem (size_t _index, const UString &_item)

const UString &	getItem (size_t _index) const

void	deleteItem (size_t _index)

void	deleteAllItems ()

size_t	findItem (const UString &_item)

size_t	getItemSelect () const

void	resetItemSelect ()

void	setItemSelect (size_t _index)

void	beginToIndex (size_t _index)

void	beginToStart ()

void	beginToEnd ()

void	beginToSelect ()

bool	isItemVisible (size_t _index, bool _fill=true)

bool	isItemSelectVisible (bool _fill=true)

Static Public Member Functions
static std::string_view	getClassTypeName ()

Static Public Member Functions inherited from MyGUI::Widget
static std::string_view	getClassTypeName ()

Static Public Member Functions inherited from MyGUI::IObject
static std::string_view	getClassTypeName ()

Widget Methods
Methods used to manipulate the widget's settings.
EventPair< EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT >	eventListSelectAccept

EventPair< EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT >	eventListChangePosition

EventPair< EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT >	eventListMouseItemActivate

EventPair< EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT >	eventListMouseItemFocus

EventPair< EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT >	eventListChangeScroll

EventHandle_ListBoxPtrCIBNotifyCellDataRef	eventNotifyItem

void	setPosition (const IntPoint &_point) override

void	setSize (const IntSize &_size) override

void	setCoord (const IntCoord &_coord) override

int	getOptimalHeight () const
	Return optimal height to fit all items in ListBox.

void	setActivateOnClick (bool activateOnClick)

Widget *	getWidgetByIndex (size_t _index)

void	_checkAlign ()

void	_setItemFocus (size_t _index, bool _focus)

void	_sendEventChangeScroll (size_t _position)

size_t	_getItemCount () const override

void	_addItem (const MyGUI::UString &_name) override

void	_removeItemAt (size_t _index) override

void	_setItemNameAt (size_t _index, const UString &_name) override

const UString &	_getItemNameAt (size_t _index) const override

void	_resetContainer (bool _update) override

void	setPosition (const IntPoint &_point) override

void	setPosition (int _left, int _top)

void	setSize (const IntSize &_size) override

void	setSize (int _width, int _height)

void	setCoord (const IntCoord &_coord) override

void	setCoord (int _left, int _top, int _width, int _height)

void	initialiseOverride () override

void	shutdownOverride () override

void	onMouseWheel (int _rel) override

void	onKeyButtonPressed (KeyCode _key, Char _char) override

void	onKeyButtonReleased (KeyCode _key) override

void	notifyScrollChangePosition (ScrollBar *_sender, size_t _position)

void	notifyMousePressed (Widget *_sender, int _left, int _top, MouseButton _id)

void	notifyMouseClick (Widget *_sender)

void	notifyMouseDoubleClick (Widget *_sender)

void	notifyMouseWheel (Widget *_sender, int _rel)

void	notifyMouseSetFocus (Widget _sender, Widget _old)

void	notifyMouseLostFocus (Widget _sender, Widget _new)

void	notifyKeyButtonPressed (Widget *_sender, KeyCode _key, Char _char)

void	notifyKeyButtonReleased (Widget *_sender, KeyCode _key)

void	notifyMouseButtonReleased (Widget *_sender, int _left, int _top, MouseButton _id)

void	updateScroll ()

void	updateLine (bool _reset=false)

void	_activateItem (Widget *_sender)

void	_setScrollView (size_t _position)

void	_redrawItemRange (size_t _start=0)

void	_redrawItem (size_t _index)

void	_selectIndex (size_t _index, bool _select)

size_t	_getItemIndex (Widget *_item) const override

void	setPropertyOverride (std::string_view _key, std::string_view _value) override

Additional Inherited Members
Data Fields inherited from MyGUI::Widget
EventHandle_WidgetStringString	eventChangeProperty

EventHandle_WidgetVoid	eventChangeCoord

EventHandle_WidgetVoid	eventWidgetDestroyed

Data Fields inherited from MyGUI::WidgetInput
EventHandle_WidgetWidget	eventMouseLostFocus

EventHandle_WidgetWidget	eventMouseSetFocus

EventPairAddParameter< EventHandle_WidgetIntInt, EventHandle_WidgetIntIntButton >	eventMouseDrag

EventHandle_WidgetIntInt	eventMouseMove

EventHandle_WidgetInt	eventMouseWheel

EventHandle_WidgetIntIntButton	eventMouseButtonPressed

EventHandle_WidgetIntIntButton	eventMouseButtonReleased

EventHandle_WidgetVoid	eventMouseButtonClick

EventHandle_WidgetVoid	eventMouseButtonDoubleClick

EventHandle_WidgetWidget	eventKeyLostFocus

EventHandle_WidgetWidget	eventKeySetFocus

EventHandle_WidgetKeyCodeChar	eventKeyButtonPressed

EventHandle_WidgetKeyCode	eventKeyButtonReleased

EventHandle_WidgetBool	eventRootMouseChangeFocus

EventHandle_WidgetBool	eventRootKeyChangeFocus

EventHandle_WidgetToolTip	eventToolTip

Protected Member Functions inherited from MyGUI::Widget
	~Widget () override=default

void	_updateView ()

Widget *	baseCreateWidget (WidgetStyle _style, std::string_view _type, std::string_view _skin, const IntCoord &_coord, Align _align, std::string_view _layer, std::string_view _name, bool _template)

void	_destroyAllChildWidget ()

virtual size_t	_getContainerIndex (const IntPoint &_point) const

virtual void	baseUpdateEnable ()

ILayerItem *	getLayerItemByPoint (int _left, int _top) const override

const IntCoord &	getLayerItemCoord () const override

template<typename T >
void	assignWidget (T *&_widget, std::string_view _name)

VectorWidgetPtr	getSkinWidgetsByName (std::string_view _name) const

virtual void	onWidgetCreated (Widget *_widget)

virtual void	onWidgetDestroy (Widget *_widget)

void	setWidgetClient (Widget *_widget)

Widget *	_getClientWidget ()
	If there is client widget return it, otherwise return this.

const Widget *	_getClientWidget () const

Protected Member Functions inherited from MyGUI::ICroppedRectangle
bool	_checkMargin ()

bool	_checkOutside () const

Protected Member Functions inherited from MyGUI::WidgetInput
virtual void	onMouseLostFocus (Widget *_new)

virtual void	onMouseSetFocus (Widget *_old)

virtual void	onMouseDrag (int _left, int _top, MouseButton _id)

virtual void	onMouseMove (int _left, int _top)

virtual void	onMouseButtonPressed (int _left, int _top, MouseButton _id)

virtual void	onMouseButtonReleased (int _left, int _top, MouseButton _id)

virtual void	onMouseButtonClick ()

virtual void	onMouseButtonDoubleClick ()

virtual void	onKeyLostFocus (Widget *_new)

virtual void	onKeySetFocus (Widget *_old)

virtual void	onMouseChangeRootFocus (bool _focus)

virtual void	onKeyChangeRootFocus (bool _focus)

Protected Member Functions inherited from MyGUI::SkinItem
void	_createSkinItem (ResourceSkin *_info)

void	_deleteSkinItem ()

void	_setSkinItemAlign (const IntSize &_size)

void	_setSkinItemVisible (bool _value)

void	_setSkinItemColour (const Colour &_value)

void	_setSkinItemAlpha (float _value)

void	_correctSkinItemView ()

void	_updateSkinItemView ()

bool	_setSkinItemState (std::string_view _state)

void	_setSubSkinVisible (bool _visible)

Protected Member Functions inherited from MyGUI::LayerItem
void	attachToLayerItemNode (ILayerNode *_item, bool _deep)

void	detachFromLayerItemNode (bool _deep)

Protected Attributes inherited from MyGUI::ICroppedRectangle
IntRect	mMargin

IntCoord	mCoord

IntPoint	mAbsolutePosition

bool	mIsMargin {false}

ICroppedRectangle *	mCroppedParent {nullptr}

Detailed Description

widget description should be here.

Definition at line 27 of file MyGUI_ListBox.h.

Member Typedef Documentation

◆ Base

typedef RTTIBase MyGUI::ListBox::Base

Definition at line 29 of file MyGUI_ListBox.h.

◆ RTTIBase

typedef ListBox MyGUI::ListBox::RTTIBase

Definition at line 29 of file MyGUI_ListBox.h.

Member Function Documentation

◆ _activateItem()

void MyGUI::ListBox::_activateItem ( MyGUI::Widget * _sender )

protected

Definition at line 955 of file MyGUI_ListBox.cpp.

◆ _addItem()

void MyGUI::ListBox::_addItem ( const MyGUI::UString & _name )

overridevirtual

Reimplemented from MyGUI::IItemContainer.

Definition at line 1004 of file MyGUI_ListBox.cpp.

◆ _checkAlign()

void MyGUI::ListBox::_checkAlign ( )

Definition at line 830 of file MyGUI_ListBox.cpp.

◆ _getItemCount()

size_t MyGUI::ListBox::_getItemCount ( ) const

overridevirtual

Reimplemented from MyGUI::IItemContainer.

Definition at line 999 of file MyGUI_ListBox.cpp.

◆ _getItemIndex()

size_t MyGUI::ListBox::_getItemIndex ( Widget * _item ) const

overrideprotectedvirtual

Reimplemented from MyGUI::Widget.

Definition at line 916 of file MyGUI_ListBox.cpp.

◆ _getItemNameAt()

const UString & MyGUI::ListBox::_getItemNameAt ( size_t _index ) const

overridevirtual

Reimplemented from MyGUI::IItemContainer.

Definition at line 1019 of file MyGUI_ListBox.cpp.

◆ _redrawItem()

void MyGUI::ListBox::_redrawItem ( size_t _index )

protected

Definition at line 466 of file MyGUI_ListBox.cpp.

◆ _redrawItemRange()

void MyGUI::ListBox::_redrawItemRange ( size_t _start = 0 )

protected

Definition at line 416 of file MyGUI_ListBox.cpp.

◆ _removeItemAt()

void MyGUI::ListBox::_removeItemAt ( size_t _index )

overridevirtual

Reimplemented from MyGUI::IItemContainer.

Definition at line 1009 of file MyGUI_ListBox.cpp.

◆ _resetContainer()

void MyGUI::ListBox::_resetContainer ( bool _update )

overridevirtual

Reimplemented from MyGUI::Widget.

Definition at line 926 of file MyGUI_ListBox.cpp.

◆ _selectIndex()

void MyGUI::ListBox::_selectIndex	(	size_t	_index,
		bool	_select
	)

protected

Definition at line 627 of file MyGUI_ListBox.cpp.

◆ _sendEventChangeScroll()

void MyGUI::ListBox::_sendEventChangeScroll ( size_t _position )

Definition at line 809 of file MyGUI_ListBox.cpp.

◆ _setItemFocus()

void MyGUI::ListBox::_setItemFocus	(	size_t	_index,
		bool	_focus
	)

Definition at line 758 of file MyGUI_ListBox.cpp.

◆ _setItemNameAt()

void MyGUI::ListBox::_setItemNameAt	(	size_t	_index,
		const UString &	_name
	)

overridevirtual

Reimplemented from MyGUI::IItemContainer.

Definition at line 1014 of file MyGUI_ListBox.cpp.

◆ _setScrollView()

void MyGUI::ListBox::_setScrollView ( size_t _position )

protected

Definition at line 784 of file MyGUI_ListBox.cpp.

◆ addItem()

void MyGUI::ListBox::addItem	(	const UString &	_name,
		Any	_data = `Any::Null`
	)

Add an item to the end of a array.

Definition at line 873 of file MyGUI_ListBox.cpp.

◆ beginToItemAt()

void MyGUI::ListBox::beginToItemAt ( size_t _index )

Move all elements so specified becomes visible.

Definition at line 645 of file MyGUI_ListBox.cpp.

◆ beginToItemFirst()

void MyGUI::ListBox::beginToItemFirst ( )

Move all elements so first becomes visible.

Definition at line 893 of file MyGUI_ListBox.cpp.

◆ beginToItemLast()

void MyGUI::ListBox::beginToItemLast ( )

Move all elements so last becomes visible.

Definition at line 899 of file MyGUI_ListBox.cpp.

◆ beginToItemSelected()

void MyGUI::ListBox::beginToItemSelected ( )

Move all elements so selected becomes visible.

Definition at line 905 of file MyGUI_ListBox.cpp.

◆ clearIndexSelected()

void MyGUI::ListBox::clearIndexSelected ( )

Clear item selection

Definition at line 883 of file MyGUI_ListBox.cpp.

◆ clearItemDataAt()

void MyGUI::ListBox::clearItemDataAt ( size_t _index )

Clear an item data at a specified position.

Definition at line 888 of file MyGUI_ListBox.cpp.

◆ findItemIndexWith()

size_t MyGUI::ListBox::findItemIndexWith ( const UString & _name )

Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found.

Definition at line 853 of file MyGUI_ListBox.cpp.

◆ getClassTypeName()

static std::string_view MyGUI::ListBox::getClassTypeName ( )

inlinestatic

Definition at line 29 of file MyGUI_ListBox.h.

◆ getIndexSelected()

size_t MyGUI::ListBox::getIndexSelected ( ) const

Get index of selected item (ITEM_NONE if none selected)

Definition at line 878 of file MyGUI_ListBox.cpp.

◆ getItemCount()

size_t MyGUI::ListBox::getItemCount ( ) const

Get number of items.

Definition at line 868 of file MyGUI_ListBox.cpp.

◆ getItemDataAt()

template<typename ValueType >

ValueType * MyGUI::ListBox::getItemDataAt	(	size_t	_index,
		bool	_throw = `true`
	)		const

inline

Get item data from specified position.

Definition at line 94 of file MyGUI_ListBox.h.

◆ getItemNameAt()

const UString & MyGUI::ListBox::getItemNameAt ( size_t _index ) const

Get item name from specified position.

Definition at line 733 of file MyGUI_ListBox.cpp.

◆ getOptimalHeight()

int MyGUI::ListBox::getOptimalHeight ( ) const

Return optimal height to fit all items in ListBox.

Definition at line 863 of file MyGUI_ListBox.cpp.

◆ getTypeName()

virtual std::string_view MyGUI::ListBox::getTypeName ( ) const

inlineoverridevirtual

Get type name as string

Reimplemented from MyGUI::Widget.

Definition at line 29 of file MyGUI_ListBox.h.

◆ getWidgetByIndex()

Widget * MyGUI::ListBox::getWidgetByIndex ( size_t _index )

Get item Widget pointer by item index if it is visible

Note: returned widget can be deleted, so this pointer is valid only at time when you got it and can be invalid next frame

Definition at line 1060 of file MyGUI_ListBox.cpp.

◆ initialiseOverride()

void MyGUI::ListBox::initialiseOverride ( )

overrideprotectedvirtual

Reimplemented from MyGUI::Widget.

Definition at line 19 of file MyGUI_ListBox.cpp.

◆ insertItemAt()

void MyGUI::ListBox::insertItemAt	(	size_t	_index,
		const UString &	_name,
		Any	_data = `Any::Null`
	)

Insert an item into a array at a specified position.

Definition at line 481 of file MyGUI_ListBox.cpp.

◆ isItemSelectedVisible()

bool MyGUI::ListBox::isItemSelectedVisible ( bool _fill = true )

Same as ListBox::isItemVisibleAt for selected item.

Definition at line 911 of file MyGUI_ListBox.cpp.

◆ isItemVisibleAt()

bool MyGUI::ListBox::isItemVisibleAt	(	size_t	_index,
		bool	_fill = `true`
	)

Return true if item visible

Parameters

_index	of item
_fill	false: function return true when whole item is visible true: function return true when at least part of item is visible

Definition at line 665 of file MyGUI_ListBox.cpp.

◆ isType() [1/2]

template<typename Type >

bool MyGUI::ListBox::isType ( ) const

inline

Compare with selected type

Definition at line 29 of file MyGUI_ListBox.h.

◆ isType() [2/2]

virtual bool MyGUI::ListBox::isType ( const std::type_info & _type ) const

inlineoverridevirtual

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 29 of file MyGUI_ListBox.h.

◆ notifyKeyButtonPressed()

void MyGUI::ListBox::notifyKeyButtonPressed	(	Widget *	_sender,
		KeyCode	_key,
		Char	_char
	)

protected

Definition at line 1031 of file MyGUI_ListBox.cpp.

◆ notifyKeyButtonReleased()

void MyGUI::ListBox::notifyKeyButtonReleased	(	Widget *	_sender,
		KeyCode	_key
	)

protected

Definition at line 1036 of file MyGUI_ListBox.cpp.

◆ notifyMouseButtonReleased()

void MyGUI::ListBox::notifyMouseButtonReleased	(	Widget *	_sender,
		int	_left,
		int	_top,
		MouseButton	_id
	)

protected

Definition at line 1041 of file MyGUI_ListBox.cpp.

◆ notifyMouseClick()

void MyGUI::ListBox::notifyMouseClick ( MyGUI::Widget * _sender )

protected

Definition at line 228 of file MyGUI_ListBox.cpp.

◆ notifyMouseDoubleClick()

void MyGUI::ListBox::notifyMouseDoubleClick ( Widget * _sender )

protected

Definition at line 234 of file MyGUI_ListBox.cpp.

◆ notifyMouseLostFocus()

void MyGUI::ListBox::notifyMouseLostFocus	(	Widget *	_sender,
		Widget *	_new
	)

protected

Definition at line 749 of file MyGUI_ListBox.cpp.

◆ notifyMousePressed()

void MyGUI::ListBox::notifyMousePressed	(	Widget *	_sender,
		int	_left,
		int	_top,
		MouseButton	_id
	)

protected

Definition at line 218 of file MyGUI_ListBox.cpp.

◆ notifyMouseSetFocus()

void MyGUI::ListBox::notifyMouseSetFocus	(	Widget *	_sender,
		Widget *	_old
	)

protected

Definition at line 739 of file MyGUI_ListBox.cpp.

◆ notifyMouseWheel()

void MyGUI::ListBox::notifyMouseWheel	(	Widget *	_sender,
		int	_rel
	)

protected

Definition at line 183 of file MyGUI_ListBox.cpp.

◆ notifyScrollChangePosition()

void MyGUI::ListBox::notifyScrollChangePosition	(	ScrollBar *	_sender,
		size_t	_position
	)

protected

Definition at line 212 of file MyGUI_ListBox.cpp.

◆ onKeyButtonPressed()

void MyGUI::ListBox::onKeyButtonPressed	(	KeyCode	_key,
		Char	_char
	)

overrideprotectedvirtual

Reimplemented from MyGUI::WidgetInput.

Definition at line 70 of file MyGUI_ListBox.cpp.

◆ onKeyButtonReleased()

void MyGUI::ListBox::onKeyButtonReleased ( KeyCode _key )

overrideprotectedvirtual

Reimplemented from MyGUI::WidgetInput.

Definition at line 1048 of file MyGUI_ListBox.cpp.

◆ onMouseWheel()

void MyGUI::ListBox::onMouseWheel ( int _rel )

overrideprotectedvirtual

Reimplemented from MyGUI::WidgetInput.

Definition at line 63 of file MyGUI_ListBox.cpp.

◆ removeAllItems()

void MyGUI::ListBox::removeAllItems ( )

Remove all items.

Definition at line 698 of file MyGUI_ListBox.cpp.

◆ removeItemAt()

void MyGUI::ListBox::removeItemAt ( size_t _index )

Remove item at a specified position.

Definition at line 543 of file MyGUI_ListBox.cpp.

◆ setActivateOnClick()

void MyGUI::ListBox::setActivateOnClick ( bool activateOnClick )

Enable "Activate on click" mode that requires a full mouse click (press and release) to activate an item. By default, items are activated on mouse press.

Definition at line 1055 of file MyGUI_ListBox.cpp.

◆ setCoord() [1/3]

void MyGUI::ListBox::setCoord ( const IntCoord & _coord )

overridevirtual

Set widget position and size

Reimplemented from MyGUI::ICroppedRectangle.

Definition at line 253 of file MyGUI_ListBox.cpp.

◆ setCoord() [2/3]

void MyGUI::Widget::setCoord ( const IntCoord & _coord )

overridevirtual

Set widget position and size

Reimplemented from MyGUI::ICroppedRectangle.

Definition at line 172 of file MyGUI_Widget.cpp.

◆ setCoord() [3/3]

void MyGUI::Widget::setCoord	(	int	_left,
		int	_top,
		int	_width,
		int	_height
	)

See Widget::setCoord(const IntCoord& _coord)

Definition at line 179 of file MyGUI_Widget.cpp.

◆ setIndexSelected()

void MyGUI::ListBox::setIndexSelected ( size_t _index )

Select specified _index

Definition at line 616 of file MyGUI_ListBox.cpp.

◆ setItemDataAt()

void MyGUI::ListBox::setItemDataAt	(	size_t	_index,
		Any	_data
	)

Replace an item data at a specified position.

Definition at line 726 of file MyGUI_ListBox.cpp.

◆ setItemNameAt()

void MyGUI::ListBox::setItemNameAt	(	size_t	_index,
		const UString &	_name
	)

Replace an item name at a specified position.

Definition at line 719 of file MyGUI_ListBox.cpp.

◆ setPosition() [1/3]

void MyGUI::ListBox::setPosition ( const IntPoint & _point )

overridevirtual

Set widget position (position of left top corner)

Reimplemented from MyGUI::ICroppedRectangle.

Definition at line 240 of file MyGUI_ListBox.cpp.

◆ setPosition() [2/3]

void MyGUI::Widget::setPosition ( const IntPoint & _point )

overridevirtual

Set widget position (position of left top corner)

Reimplemented from MyGUI::ICroppedRectangle.

Definition at line 168 of file MyGUI_Widget.cpp.

◆ setPosition() [3/3]

void MyGUI::Widget::setPosition	(	int	_left,
		int	_top
	)

See Widget::setPosition(const IntPoint& _pos)

Definition at line 175 of file MyGUI_Widget.cpp.

◆ setPropertyOverride()

void MyGUI::ListBox::setPropertyOverride	(	std::string_view	_key,
		std::string_view	_value
	)

overrideprotectedvirtual

Reimplemented from MyGUI::Widget.

Definition at line 939 of file MyGUI_ListBox.cpp.

◆ setScrollPosition()

void MyGUI::ListBox::setScrollPosition ( size_t _position )

Set scroll position.

Definition at line 772 of file MyGUI_ListBox.cpp.

◆ setScrollVisible()

void MyGUI::ListBox::setScrollVisible ( bool _visible )

Set scroll visible when it needed.

Definition at line 764 of file MyGUI_ListBox.cpp.

◆ setSize() [1/3]

void MyGUI::ListBox::setSize ( const IntSize & _size )

overridevirtual

Set widget size

Reimplemented from MyGUI::ICroppedRectangle.

Definition at line 245 of file MyGUI_ListBox.cpp.

◆ setSize() [2/3]

void MyGUI::Widget::setSize ( const IntSize & _size )

overridevirtual

Set widget size

Reimplemented from MyGUI::ICroppedRectangle.

Definition at line 170 of file MyGUI_Widget.cpp.

◆ setSize() [3/3]

void MyGUI::Widget::setSize	(	int	_width,
		int	_height
	)

See Widget::setSize(const IntSize& _size)

Definition at line 177 of file MyGUI_Widget.cpp.

◆ shutdownOverride()

void MyGUI::ListBox::shutdownOverride ( )

overrideprotectedvirtual

Reimplemented from MyGUI::Widget.

Definition at line 56 of file MyGUI_ListBox.cpp.

◆ swapItemsAt()

void MyGUI::ListBox::swapItemsAt	(	size_t	_index1,
		size_t	_index2
	)

Swap items at a specified positions.

Definition at line 816 of file MyGUI_ListBox.cpp.

◆ updateLine()

void MyGUI::ListBox::updateLine ( bool _reset = false )

protected

Definition at line 296 of file MyGUI_ListBox.cpp.

◆ updateScroll()

void MyGUI::ListBox::updateScroll ( )

protected

Definition at line 261 of file MyGUI_ListBox.cpp.

Field Documentation

◆ eventListChangePosition

EventPair<EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT> MyGUI::ListBox::eventListChangePosition

Event : Selected item position changed.
signature : void method(MyGUI::ListBox* _sender, size_t _index)

Parameters

_sender	widget that called this event
_index	of new item

Definition at line 198 of file MyGUI_ListBox.h.

◆ eventListChangeScroll

EventPair<EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT> MyGUI::ListBox::eventListChangeScroll

Event : Position of scroll changed.
signature : void method(MyGUI::ListBox* _sender, size_t _position)

Parameters

_sender	widget that called this event
_position	of scroll

Definition at line 219 of file MyGUI_ListBox.h.

◆ eventListMouseItemActivate

EventPair<EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT> MyGUI::ListBox::eventListMouseItemActivate

Event : Item was selected by mouse.
signature : void method(MyGUI::ListBox* _sender, size_t _index)

Parameters

_sender	widget that called this event
_index	index of selected item

Definition at line 205 of file MyGUI_ListBox.h.

◆ eventListMouseItemFocus

EventPair<EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT> MyGUI::ListBox::eventListMouseItemFocus

Event : Mouse is over item.
signature : void method(MyGUI::ListBox* _sender, size_t _index)

Parameters

_sender	widget that called this event
_index	of focused item

Definition at line 212 of file MyGUI_ListBox.h.

◆ eventListSelectAccept

EventPair<EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT> MyGUI::ListBox::eventListSelectAccept

Event : Enter pressed or double click.
signature : void method(MyGUI::ListBox* _sender, size_t _index)

Parameters

_sender	widget that called this event
_index	of selected item

Definition at line 191 of file MyGUI_ListBox.h.

◆ eventNotifyItem

EventHandle_ListBoxPtrCIBNotifyCellDataRef MyGUI::ListBox::eventNotifyItem

Event : Notify about event in item widget.
signature : void method(MyGUI::ListBox* _sender, const MyGUI::IBNotifyItemData& _info)

Parameters

_sender	widget that called this event
_info	info about item notify

Definition at line 226 of file MyGUI_ListBox.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Widget Methods

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

◆ RTTIBase

Member Function Documentation

◆ _activateItem()

◆ _addItem()

◆ _checkAlign()

◆ _getItemCount()

◆ _getItemIndex()

◆ _getItemNameAt()

◆ _redrawItem()

◆ _redrawItemRange()

◆ _removeItemAt()

◆ _resetContainer()

◆ _selectIndex()

◆ _sendEventChangeScroll()

◆ _setItemFocus()

◆ _setItemNameAt()

◆ _setScrollView()

◆ addItem()

◆ beginToItemAt()

◆ beginToItemFirst()

◆ beginToItemLast()

◆ beginToItemSelected()

◆ clearIndexSelected()

◆ clearItemDataAt()

◆ findItemIndexWith()

◆ getClassTypeName()

◆ getIndexSelected()

◆ getItemCount()

◆ getItemDataAt()

◆ getItemNameAt()

◆ getOptimalHeight()

◆ getTypeName()

◆ getWidgetByIndex()

◆ initialiseOverride()

◆ insertItemAt()

◆ isItemSelectedVisible()

◆ isItemVisibleAt()

◆ isType() [1/2]

◆ isType() [2/2]

◆ notifyKeyButtonPressed()

◆ notifyKeyButtonReleased()

◆ notifyMouseButtonReleased()

◆ notifyMouseClick()

◆ notifyMouseDoubleClick()

◆ notifyMouseLostFocus()

◆ notifyMousePressed()

◆ notifyMouseSetFocus()

◆ notifyMouseWheel()

◆ notifyScrollChangePosition()

◆ onKeyButtonPressed()

◆ onKeyButtonReleased()

◆ onMouseWheel()

◆ removeAllItems()

◆ removeItemAt()

◆ setActivateOnClick()

◆ setCoord() [1/3]

◆ setCoord() [2/3]

◆ setCoord() [3/3]

◆ setIndexSelected()

◆ setItemDataAt()

◆ setItemNameAt()

◆ setPosition() [1/3]

◆ setPosition() [2/3]

◆ setPosition() [3/3]

◆ setPropertyOverride()

◆ setScrollPosition()

◆ setScrollVisible()

◆ setSize() [1/3]

◆ setSize() [2/3]

◆ setSize() [3/3]

◆ shutdownOverride()

◆ swapItemsAt()