MyGUI::ListCtrl Class Reference

#include <MyGUI_ListCtrl.h>

Inheritance diagram for MyGUI::ListCtrl:

Data Structures
struct	ItemDataInfo
Public Member Functions
	ListCtrl ()
size_t	getItemCount ()
	Get number of items.
void	insertItemAt (size_t _index, Any _data=Any::Null)
	Insert an item into a array at a specified position.
void	addItem (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	redrawItemAt (size_t _index)
	Redraw at a specified position.
void	redrawAllItems ()
	Redraw all items.
size_t	getIndexSelected ()
	Get index of selected item (ITEM_NONE if none selected).
void	setIndexSelected (size_t _index)
	Select specified _index.
void	clearIndexSelected ()
	Clear item selection.
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)
	Get item data from specified position.
size_t	getIndexByWidget (WidgetPtr _widget)
WidgetPtr	getWidgetDrag ()
WidgetPtr	getWidgetByIndex (size_t _index)
void	resetDrag ()
virtual void	setPosition (const IntPoint &_value)
virtual void	setSize (const IntSize &_value)
virtual void	setCoord (const IntCoord &_value)
void	setPosition (int _left, int _top)
void	setSize (int _width, int _height)
void	setCoord (int _left, int _top, int _width, int _height)
virtual void	_initialise (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin _info, WidgetPtr _parent, ICroppedRectangle _croppedParent, IWidgetCreator *_creator, const std::string &_name)
Data Fields
EventHandle_ListCtrlPtrWidgetPtr	requestCreateWidgetItem
EventHandle_ListCtrlPtrWidgetPtrCIBCellDrawInfoRef	requestDrawItem
EventHandle_ListCtrlPtrSizeT	eventSelectItemAccept
EventHandle_ListCtrlPtrSizeT	eventChangeItemPosition
EventHandle_ListCtrlPtrSizeT	eventMouseItemActivate
EventHandle_ListCtrlPtrCIBNotifyCellDataRef	eventNotifyItem
Protected Types
typedef std::vector< ItemDataInfo >	VectorItemInfo
Protected Member Functions
virtual	~ListCtrl ()
void	baseChangeWidgetSkin (ResourceSkin *_info)
virtual void	onMouseButtonPressed (int _left, int _top, MouseButton _id)
virtual void	onMouseButtonReleased (int _left, int _top, MouseButton _id)
virtual void	onMouseDrag (int _left, int _top)
virtual void	onMouseWheel (int _rel)
virtual void	onKeyLostFocus (WidgetPtr _new)
virtual void	onKeySetFocus (WidgetPtr _old)
void	notifyKeyButtonPressed (WidgetPtr _sender, KeyCode _key, Char _char)
void	notifyKeyButtonReleased (WidgetPtr _sender, KeyCode _key)
void	notifyScrollChangePosition (VScrollPtr _sender, size_t _index)
void	notifyMouseWheel (WidgetPtr _sender, int _rel)
void	notifyRootMouseChangeFocus (WidgetPtr _sender, bool _focus)
void	notifyMouseButtonDoubleClick (WidgetPtr _sender)
void	_requestGetContainer (WidgetPtr _sender, WidgetPtr &_container, size_t &_index)
void	notifyMouseDrag (WidgetPtr _sender, int _left, int _top)
void	notifyMouseButtonPressed (WidgetPtr _sender, int _left, int _top, MouseButton _id)
void	notifyMouseButtonReleased (WidgetPtr _sender, int _left, int _top, MouseButton _id)
virtual void	removeDropItems ()
virtual void	updateDropItems ()
virtual void	updateDropItemsState (const DDWidgetState &_state)
void	updateMetrics ()
void	_updateAllVisible (size_t _index, bool _needUpdateContetntSize, bool _update)
void	updateFromResize ()
WidgetPtr	getItemWidget (size_t _index)
void	_setContainerItemInfo (size_t _index, bool _set, bool _accept)
void	resetCurrentActiveItem ()
void	findCurrentActiveItem ()
virtual size_t	_getContainerIndex (const IntPoint &_point)
virtual void	_resetContainer (bool _update)
void	_setScrollViewPage (size_t _size)

Detailed Description

Definition at line 41 of file MyGUI_ListCtrl.h.

Member Typedef Documentation

typedef std::vector<ItemDataInfo> MyGUI::ListCtrl::VectorItemInfo [protected]

Definition at line 194 of file MyGUI_ListCtrl.h.

Constructor & Destructor Documentation

MyGUI::ListCtrl::ListCtrl ( )

Definition at line 38 of file MyGUI_ListCtrl.cpp.

MyGUI::ListCtrl::~ListCtrl ( ) [protected, virtual]

Definition at line 57 of file MyGUI_ListCtrl.cpp.

Member Function Documentation

size_t MyGUI::ListCtrl::_getContainerIndex ( const IntPoint & _point ) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 579 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::_initialise	(	WidgetStyle	_style,
		const IntCoord &	_coord,
		Align	_align,
		ResourceSkin *	_info,
		WidgetPtr	_parent,
		ICroppedRectangle *	_croppedParent,
		IWidgetCreator *	_creator,
		const std::string &	_name
	)			`[virtual]`

Reimplemented from MyGUI::DDContainer.

Reimplemented in MyGUI::ListBox.

Definition at line 50 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::_requestGetContainer	(	WidgetPtr	_sender,
		WidgetPtr &	_container,
		size_t &	_index
	)			`[protected]`

Definition at line 351 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::_resetContainer ( bool _update ) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 594 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::_setContainerItemInfo	(	size_t	_index,
		bool	_set,
		bool	_accept
	)			`[protected, virtual]`

Reimplemented from MyGUI::DDContainer.

Definition at line 369 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::_setScrollViewPage ( size_t _size ) [inline, protected]

Definition at line 247 of file MyGUI_ListCtrl.h.

void MyGUI::ListCtrl::_updateAllVisible	(	size_t	_index,
		bool	_needUpdateContetntSize,
		bool	_update
	)			`[protected]`

Definition at line 161 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::addItem ( Any _data = Any::Null ) [inline]

Add an item to the end of a array.

Definition at line 60 of file MyGUI_ListCtrl.h.

void MyGUI::ListCtrl::baseChangeWidgetSkin ( ResourceSkin * _info ) [protected, virtual]

Reimplemented from MyGUI::DDContainer.

Reimplemented in MyGUI::ListBox.

Definition at line 72 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::clearIndexSelected ( ) [inline]

Clear item selection.

Reimplemented in MyGUI::ListBox.

Definition at line 85 of file MyGUI_ListCtrl.h.

void MyGUI::ListCtrl::clearItemDataAt ( size_t _index ) [inline]

Clear an item data at a specified position.

Reimplemented in MyGUI::ListBox.

Definition at line 95 of file MyGUI_ListCtrl.h.

void MyGUI::ListCtrl::findCurrentActiveItem ( ) [protected]

Definition at line 310 of file MyGUI_ListCtrl.cpp.

size_t MyGUI::ListCtrl::getIndexByWidget ( WidgetPtr _widget )

Get item index by item Widget pointer

Definition at line 567 of file MyGUI_ListCtrl.cpp.

size_t MyGUI::ListCtrl::getIndexSelected ( ) [inline]

Get index of selected item (ITEM_NONE if none selected).

Reimplemented in MyGUI::ListBox.

Definition at line 79 of file MyGUI_ListCtrl.h.

size_t MyGUI::ListCtrl::getItemCount ( ) [inline]

Get number of items.

Reimplemented in MyGUI::ListBox.

Definition at line 54 of file MyGUI_ListCtrl.h.

template<typename ValueType >

ValueType* MyGUI::ListCtrl::getItemDataAt	(	size_t	_index,
		bool	_throw = `true`
	)			`[inline]`

Get item data from specified position.

Reimplemented in MyGUI::ListBox.

Definition at line 99 of file MyGUI_ListCtrl.h.

WidgetPtr MyGUI::ListCtrl::getItemWidget ( size_t _index ) [protected]

Definition at line 230 of file MyGUI_ListCtrl.cpp.

WidgetPtr MyGUI::ListCtrl::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 609 of file MyGUI_ListCtrl.cpp.

WidgetPtr MyGUI::ListCtrl::getWidgetDrag ( ) [inline]

Get widget created for drop

Definition at line 110 of file MyGUI_ListCtrl.h.

void MyGUI::ListCtrl::insertItemAt	(	size_t	_index,
		Any	_data = `Any::Null`
	)

Insert an item into a array at a specified position.

Definition at line 415 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::notifyKeyButtonPressed	(	WidgetPtr	_sender,
		KeyCode	_key,
		Char	_char
	)			`[protected]`

Definition at line 557 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::notifyKeyButtonReleased	(	WidgetPtr	_sender,
		KeyCode	_key
	)			`[protected]`

Definition at line 562 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::notifyMouseButtonDoubleClick ( WidgetPtr _sender ) [protected]

Definition at line 550 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::notifyMouseButtonPressed	(	WidgetPtr	_sender,
		int	_left,
		int	_top,
		MouseButton	_id
	)			`[protected]`

Definition at line 689 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::notifyMouseButtonReleased	(	WidgetPtr	_sender,
		int	_left,
		int	_top,
		MouseButton	_id
	)			`[protected]`

Definition at line 723 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::notifyMouseDrag	(	WidgetPtr	_sender,
		int	_left,
		int	_top
	)			`[protected]`

Definition at line 684 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::notifyMouseWheel	(	WidgetPtr	_sender,
		int	_rel
	)			`[protected]`

Definition at line 819 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::notifyRootMouseChangeFocus	(	WidgetPtr	_sender,
		bool	_focus
	)			`[protected]`

Definition at line 729 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::notifyScrollChangePosition	(	VScrollPtr	_sender,
		size_t	_index
	)			`[protected]`

Definition at line 797 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::onKeyLostFocus ( WidgetPtr _new ) [protected, virtual]

Reimplemented from MyGUI::WidgetEvent.

Definition at line 275 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::onKeySetFocus ( WidgetPtr _old ) [protected, virtual]

Reimplemented from MyGUI::WidgetEvent.

Definition at line 267 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::onMouseButtonPressed	(	int	_left,
		int	_top,
		MouseButton	_id
	)			`[protected, virtual]`

Reimplemented from MyGUI::DDContainer.

Definition at line 623 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::onMouseButtonReleased	(	int	_left,
		int	_top,
		MouseButton	_id
	)			`[protected, virtual]`

Reimplemented from MyGUI::DDContainer.

Definition at line 628 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::onMouseDrag	(	int	_left,
		int	_top
	)			`[protected, virtual]`

Reimplemented from MyGUI::DDContainer.

Definition at line 633 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::onMouseWheel ( int _rel ) [protected, virtual]

Reimplemented from MyGUI::WidgetEvent.

Definition at line 260 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::redrawAllItems ( ) [inline]

Redraw all items.

Definition at line 72 of file MyGUI_ListCtrl.h.

void MyGUI::ListCtrl::redrawItemAt ( size_t _index )

Redraw at a specified position.

Definition at line 489 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::removeAllItems ( )

Remove all items.

Reimplemented in MyGUI::ListBox.

Definition at line 473 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::removeDropItems ( ) [protected, virtual]

Reimplemented from MyGUI::DDContainer.

Definition at line 638 of file MyGUI_ListCtrl.cpp.

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

Remove item at a specified position.

Reimplemented in MyGUI::ListBox.

Definition at line 443 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::resetCurrentActiveItem ( ) [protected]

Definition at line 283 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::resetDrag ( )

Interrupt drag as if widget was dropped into empty space

Definition at line 850 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::setCoord	(	int	_left,
		int	_top,
		int	_width,
		int	_height
	)			`[inline]`

See Widget::setCoord(const IntCoord& _coord)

Reimplemented from MyGUI::Widget.

Definition at line 134 of file MyGUI_ListCtrl.h.

void MyGUI::ListCtrl::setCoord ( const IntCoord & _value ) [virtual]

Set widget position and size

Reimplemented from MyGUI::Widget.

Definition at line 144 of file MyGUI_ListCtrl.cpp.

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

Select specified _index.

Reimplemented in MyGUI::ListBox.

Definition at line 506 of file MyGUI_ListCtrl.cpp.

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

Replace an item data at a specified position.

Reimplemented in MyGUI::ListBox.

Definition at line 395 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::setPosition	(	int	_left,
		int	_top
	)			`[inline]`

See Widget::setPosition(const IntPoint& _pos)

Reimplemented from MyGUI::Widget.

Definition at line 130 of file MyGUI_ListCtrl.h.

void MyGUI::ListCtrl::setPosition ( const IntPoint & _value ) [virtual]

Set widget position (position of left top corner)

Reimplemented from MyGUI::Widget.

Definition at line 133 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::setSize	(	int	_width,
		int	_height
	)			`[inline]`

See Widget::setSize(const IntSize& _size)

Reimplemented from MyGUI::Widget.

Definition at line 132 of file MyGUI_ListCtrl.h.

void MyGUI::ListCtrl::setSize ( const IntSize & _value ) [virtual]

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 138 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::updateDropItems ( ) [protected, virtual]

Reimplemented from MyGUI::DDContainer.

Definition at line 643 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::updateDropItemsState ( const DDWidgetState & _state ) [protected, virtual]

Reimplemented from MyGUI::DDContainer.

Definition at line 665 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::updateFromResize ( ) [protected]

Definition at line 150 of file MyGUI_ListCtrl.cpp.

void MyGUI::ListCtrl::updateMetrics ( ) [protected]

Definition at line 783 of file MyGUI_ListCtrl.cpp.

Field Documentation

EventHandle_ListCtrlPtrSizeT MyGUI::ListCtrl::eventChangeItemPosition

Event : position of selected item was changed signature : void method(MyGUI::ListCtrlPtr _sender, size_t _index)

Parameters:

	_sender	widget that called this event
	_index	item index

Definition at line 165 of file MyGUI_ListCtrl.h.

EventHandle_ListCtrlPtrSizeT MyGUI::ListCtrl::eventMouseItemActivate

Event : click on item signature : void method(MyGUI::ListCtrlPtr _sender, size_t _index)

Parameters:

	_sender	widget that called this event
	_index	item index

Definition at line 172 of file MyGUI_ListCtrl.h.

EventHandle_ListCtrlPtrCIBNotifyCellDataRef MyGUI::ListCtrl::eventNotifyItem

Event : notify about event in item widget signature : void method(MyGUI::ListCtrlPtr _sender, const MyGUI::IBNotifyItemData& _info)

Parameters:

	_sender	widget that called this event
	_info	info about item notify

Definition at line 179 of file MyGUI_ListCtrl.h.

EventHandle_ListCtrlPtrSizeT MyGUI::ListCtrl::eventSelectItemAccept

Event : doubleclick or enter pressed on item signature : void method(MyGUI::ListCtrlPtr _sender, size_t _index)

Parameters:

	_sender	widget that called this event
	_index	item index

Definition at line 158 of file MyGUI_ListCtrl.h.

EventHandle_ListCtrlPtrWidgetPtr MyGUI::ListCtrl::requestCreateWidgetItem

Event : request for creating new item signature : void method(MyGUI::ListCtrlPtr _sender, MyGUI::WidgetPtr _item)

Parameters:

	_sender	widget that called this event
	_item	widget item pointer

Definition at line 143 of file MyGUI_ListCtrl.h.

EventHandle_ListCtrlPtrWidgetPtrCIBCellDrawInfoRef MyGUI::ListCtrl::requestDrawItem

Event : request for item redraw signature : void method(MyGUI::ListCtrlPtr _sender, MyGUI::WidgetPtr _item, const MyGUI::IBDrawItemInfo& _info)

Parameters:

	_sender	widget that called this event
	_item	widget item pointer
	_info	item info

Definition at line 151 of file MyGUI_ListCtrl.h.

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

MyGUI::ListCtrl Class Reference

Data Structures

Public Member Functions

Data Fields

Protected Types

Protected Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation