SallyAPI::GUI::CListView Class Reference

List view. Depricated, please use CListViewExt. More...

#include <ListView.h>

Inheritance diagram for SallyAPI::GUI::CListView:

List of all members.

Public Member Functions
	CListView (SallyAPI::GUI::CGUIBaseObject *parent, int x, int y, int width, int height, int cols, int actionGraphic, std::vector< int > &pictureList, int controlId=0)
	Constructor. Depricated!!!
	CListView (SallyAPI::GUI::CGUIBaseObject *parent, int x, int y, int width, int height, int cols, int actionGraphic, int controlId=0)
	Constructor.
virtual	~CListView ()
	Destructor.
int	GetMaxDisplayedElements ()
	Gets the maximum displayed elements.
int	GetListSize ()
	Gets the list size.
void	AddItem (SallyAPI::GUI::CListViewItem listItem)
	Adds an item.
bool	RemoveItem (int index)
	Removes the item described by index.
void	UpdateView ()
	Updates this object.
void	Clear ()
	Clears this object to its blank/initial state.
std::vector < SallyAPI::GUI::CListViewItem * > *	GetListItems ()
	Gets the list items.
SallyAPI::GUI::CListViewItem *	GetItem (int index)
	Gets the requested item by index.
void	SetActive (int index)
	Sets an active.
int	GetActive ()
	Gets the index of the active element.
int	GetStartItem ()
	Gets the start item.
void	SetStartItem (int startItem)
	Sets a start item.
void	SetPictureList (std::vector< int > &pictureList)
	Sets a picture list.
void	RemovePictureList ()
	Removes a picture list.
void	SetActionImageId (int icon)
	Sets an action image identifier.
void	ShowScrollbarIfNotScrollable (bool value)
	Shows the scrollbar if not scrollable.
bool	IsScrollbarVisibleIfNotScrollbable ()
	Query if this object is scrollbar visible if not scrollbable.
virtual void	SetAlphaBlending (int alphaBlending)
	Sets an alpha blending.
virtual bool	CheckProcessMouseUp (int x, int y)
	Check process mouse up.
virtual bool	CheckProcessMouseDown (int x, int y)
	Check process mouse down.
virtual void	Enable (bool enable)
	Enables.
virtual void	Timer (float timeDelta)
	Timers.
virtual void	SendMessageToChilds (SallyAPI::GUI::CGUIBaseObject *reporter, int reporterId, int messageId, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter=NULL)
	Send message to childs.
virtual void	SendMessageToParent (SallyAPI::GUI::CGUIBaseObject *reporter, int reporterId, int messageId, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter=NULL)
	Send message to parent.
Protected Member Functions
void	CreateListView ()
	Creates the list view.
void	ResetListView ()
	Resets a list view.
int	GetMaxItemStart ()
	Gets the maximum item start.
bool	ResetBox2Object ()
	Resets a box 2 object.
void	OnCommandScrollbarMoved (SallyAPI::GUI::CGUIBaseObject *reporter, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter)
	Executes the command scrollbar moved action.
void	OnCommandDoubleclicked (int reporterId)
	Executes the command doubleclicked action.
void	OnCommandMouseMove (SallyAPI::GUI::SendMessage::CParameterBase *messageParameter)
	Executes the command mouse move action.
virtual void	AddChild (SallyAPI::GUI::CControl *control)
	Adds a child.
Protected Attributes
std::map< int, SallyAPI::GUI::CListViewButton * >	m_mButtonItem
std::map< int, SallyAPI::GUI::CListViewButton * >	m_mButtonAction
std::vector < SallyAPI::GUI::CListViewItem * >	m_vItems
int	m_iActionGraphic
std::vector< int >	m_vPictureList
SallyAPI::GUI::CScrollbar *	m_pScrollbar
int	m_iStartPicture
int	m_iCols
int	m_iRows
int	m_iActive
bool	m_bUseImageList
b2World *	m_pb2World
CBox2DObject *	m_pb2Object
b2Body *	m_pb2LeftBody
b2Body *	m_pb2RightBody
int	m_iOldPositionX
int	m_iOldPositionY

---

Detailed Description

List view. Depricated, please use CListViewExt.

Author:

Christian Knobloch

Date:

26.04.2010

---

Constructor & Destructor Documentation

CListView::CListView	(	SallyAPI::GUI::CGUIBaseObject *	parent,
		int	x,
		int	y,
		int	width,
		int	height,
		int	cols,
		int	actionGraphic,
		std::vector< int > &	pictureList,
		int	controlId = 0
	)

Constructor. Depricated!!!

m_iStartPicture(0), m_iCols(cols), m_iActionGraphic(actionGraphic), m_vPictureList(pictureList), m_iActive(-1), m_bUseImageList(true), m_iOldPositionX(0), m_iOldPositionY(0)

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

[in,out]	parent	If non-null, the parent.
	x	The x coordinate.
	y	The y coordinate.
	width	The width.
	height	The height.
	cols	The cols.
	actionGraphic	The action graphic.
[in,out]	pictureList	List of pictures.
	controlId	Identifier for the control.

CListView::CListView	(	SallyAPI::GUI::CGUIBaseObject *	parent,
		int	x,
		int	y,
		int	width,
		int	height,
		int	cols,
		int	actionGraphic,
		int	controlId = 0
	)

Constructor.

m_iActive(-1), m_bUseImageList(false), m_iOldPositionX(0), m_iOldPositionY(0)

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

[in,out]	parent	If non-null, the parent.
	x	The x coordinate.
	y	The y coordinate.
	width	The width.
	height	The height.
	cols	The cols.
	actionGraphic	The action graphic.
	controlId	Identifier for the control.

CListView::~CListView

(

)

[virtual]

Destructor.

Author:

Christian Knobloch

Date:

26.04.2010

---

Member Function Documentation

void CListView::AddChild

(

SallyAPI::GUI::CControl *

control

)

[protected, virtual]

Adds a child.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

[in,out]

control

If non-null, the control.

Reimplemented from SallyAPI::GUI::CForm.

void CListView::AddItem

(

SallyAPI::GUI::CListViewItem

listItem

)

Adds an item.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

listItem

The list item.

bool CListView::CheckProcessMouseDown	(	int	x,
		int	y
	)		[virtual]

Check process mouse down.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

x	The x coordinate.
y	The y coordinate.

Returns:

true if it succeeds, false if it fails.

Reimplemented from SallyAPI::GUI::CControl.

bool CListView::CheckProcessMouseUp	(	int	x,
		int	y
	)		[virtual]

Check process mouse up.

Author:

Christian Knobloch

Date:

27.04.2010

Parameters:

x	The x coordinate.
y	The y coordinate.

Returns:

true if it succeeds, false if it fails.

Reimplemented from SallyAPI::GUI::CControl.

void CListView::Clear

(

)

Clears this object to its blank/initial state.

Author:

Christian Knobloch

Date:

26.04.2010

void CListView::CreateListView

(

)

[protected]

Creates the list view.

Author:

Christian Knobloch

Date:

26.04.2010

void CListView::Enable

(

bool

enable

)

[virtual]

Enables.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

enable

true to enable, false to disable.

Reimplemented from SallyAPI::GUI::CControl.

int CListView::GetActive

(

)

Gets the index of the active element.

Author:

Christian Knobloch

Date:

26.04.2010

Returns:

The active.

SallyAPI::GUI::CListViewItem * CListView::GetItem

(

int

index

)

Gets the requested item by index.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

index

Zero-based index of the.

Returns:

null if it fails, else the item.

std::vector< SallyAPI::GUI::CListViewItem * > * CListView::GetListItems

(

)

Gets the list items.

Author:

Christian Knobloch

Date:

26.04.2010

Returns:

null if it fails, else the list items.

int CListView::GetListSize

(

)

Gets the list size.

Author:

Christian Knobloch

Date:

26.04.2010

Returns:

The list size.

int CListView::GetMaxDisplayedElements

(

)

Gets the maximum displayed elements.

Author:

Christian Knobloch

Date:

26.04.2010

Returns:

The maximum displayed elements.

int CListView::GetMaxItemStart

(

)

[protected]

Gets the maximum item start.

Author:

Christian Knobloch

Date:

26.04.2010

Returns:

The maximum item start.

int CListView::GetStartItem

(

)

Gets the start item.

Author:

Christian Knobloch

Date:

26.04.2010

Returns:

The start item.

bool CListView::IsScrollbarVisibleIfNotScrollbable

(

void

)

Query if this object is scrollbar visible if not scrollbable.

Author:

Christian Knobloch

Date:

27.04.2010

Returns:

true if scrollbar visible if not scrollbable, false if not.

void CListView::OnCommandDoubleclicked

(

int

reporterId

)

[protected]

Executes the command doubleclicked action.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

reporterId

Identifier for the reporter.

void CListView::OnCommandMouseMove

(

SallyAPI::GUI::SendMessage::CParameterBase *

messageParameter

)

[protected]

Executes the command mouse move action.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

[in,out]

messageParameter

If non-null, the message parameter.

void CListView::OnCommandScrollbarMoved	(	SallyAPI::GUI::CGUIBaseObject *	reporter,
		SallyAPI::GUI::SendMessage::CParameterBase *	messageParameter
	)		[protected]

Executes the command scrollbar moved action.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

[in,out]	reporter	If non-null, the reporter.
[in,out]	messageParameter	If non-null, the message parameter.

bool CListView::RemoveItem

(

int

index

)

Removes the item described by index.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

index

Zero-based index of the.

Returns:

true if it succeeds, false if it fails.

void CListView::RemovePictureList

(

)

Removes a picture list.

Author:

Christian Knobloch

Date:

26.04.2010

bool CListView::ResetBox2Object

(

)

[protected]

Resets a box 2 object.

Author:

Christian Knobloch

Date:

26.04.2010

Returns:

true if it succeeds, false if it fails.

void CListView::ResetListView

(

)

[protected]

Resets a list view.

Author:

Christian Knobloch

Date:

26.04.2010

void CListView::SendMessageToChilds	(	SallyAPI::GUI::CGUIBaseObject *	reporter,
		int	reporterId,
		int	messageId,
		SallyAPI::GUI::SendMessage::CParameterBase *	messageParameter = NULL
	)		[virtual]

Send message to childs.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

[in,out]	reporter	If non-null, the reporter.
	reporterId	Identifier for the reporter.
	messageId	Identifier for the message.
[in,out]	messageParameter	If non-null, the message parameter.

Reimplemented from SallyAPI::GUI::CForm.

void CListView::SendMessageToParent	(	SallyAPI::GUI::CGUIBaseObject *	reporter,
		int	reporterId,
		int	messageId,
		SallyAPI::GUI::SendMessage::CParameterBase *	messageParameter = NULL
	)		[virtual]

Send message to parent.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

[in,out]	reporter	If non-null, the reporter.
	reporterId	Identifier for the reporter.
	messageId	Identifier for the message.
[in,out]	messageParameter	If non-null, the message parameter.

Reimplemented from SallyAPI::GUI::CForm.

void CListView::SetActionImageId

(

int

icon

)

Sets an action image identifier.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

icon

The icon.

void CListView::SetActive

(

int

index

)

Sets an active.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

index

Zero-based index of the.

void CListView::SetAlphaBlending

(

int

alphaBlending

)

[virtual]

Sets an alpha blending.

Author:

Christian Knobloch

Date:

03.04.2011

Parameters:

alphaBlending

The alpha blending.

Reimplemented from SallyAPI::GUI::CForm.

void CListView::SetPictureList

(

std::vector< int > &

pictureList

)

Sets a picture list.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

[in,out]

pictureList

List of pictures.

void CListView::SetStartItem

(

int

startItem

)

Sets a start item.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

startItem

The start item.

void CListView::ShowScrollbarIfNotScrollable

(

bool

value

)

Shows the scrollbar if not scrollable.

Author:

Christian Knobloch

Date:

27.04.2010

Parameters:

value

true to value.

void CListView::Timer

(

float

timeDelta

)

[virtual]

Timers.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

timeDelta

The time delta.

Reimplemented from SallyAPI::GUI::CForm.

void CListView::UpdateView

(

)

Updates this object.

Author:

Christian Knobloch

Date:

26.04.2010

---

Member Data Documentation

bool SallyAPI::GUI::CListView::m_bUseImageList [protected]

int SallyAPI::GUI::CListView::m_iActionGraphic [protected]

int SallyAPI::GUI::CListView::m_iActive [protected]

int SallyAPI::GUI::CListView::m_iCols [protected]

int SallyAPI::GUI::CListView::m_iOldPositionX [protected]

int SallyAPI::GUI::CListView::m_iOldPositionY [protected]

int SallyAPI::GUI::CListView::m_iRows [protected]

int SallyAPI::GUI::CListView::m_iStartPicture [protected]

std::map<int, SallyAPI::GUI::CListViewButton*> SallyAPI::GUI::CListView::m_mButtonAction [protected]

std::map<int, SallyAPI::GUI::CListViewButton*> SallyAPI::GUI::CListView::m_mButtonItem [protected]

b2Body* SallyAPI::GUI::CListView::m_pb2LeftBody [protected]

CBox2DObject* SallyAPI::GUI::CListView::m_pb2Object [protected]

b2Body* SallyAPI::GUI::CListView::m_pb2RightBody [protected]

b2World* SallyAPI::GUI::CListView::m_pb2World [protected]

SallyAPI::GUI::CScrollbar* SallyAPI::GUI::CListView::m_pScrollbar [protected]

std::vector<SallyAPI::GUI::CListViewItem*> SallyAPI::GUI::CListView::m_vItems [protected]

std::vector<int> SallyAPI::GUI::CListView::m_vPictureList [protected]

---

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

• D:/source/c++/Programme/sally/sally/sallyAPI/ListView.h
• D:/source/c++/Programme/sally/sally/sallyAPI/ListView.cpp
• D:/source/c++/Programme/sally/sally/sallyAPI/ListViewExt.cpp