RVC::UI::FORM_OBJECT_LIST Class Reference

Form containing basic object selection list with "select", "remove", and "remove all" buttons. More...

#include <rvc/uiformobjectlist.h>

Inheritance diagram for RVC::UI::FORM_OBJECT_LIST:

Public Member Functions
	FORM_OBJECT_LIST ()
virtual	~FORM_OBJECT_LIST ()
void	Clear (bool notify)
ERRVALUE	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, const MISTRING &promptstr, const RVC::OBJTYPESET &ObjTypeSet, GETOBJFLAGS GetObjFlags=GETOBJFLAG_None, RVC::GETOBJFILTER *GetObjFilter=0, int ListHeight=5, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_Expand)
MGUI::LAYOUT_PANE &	GetBtnPane ()
const RVC::OBJITEM &	GetCurrentObject () const
const RVC::OBJITEMLIST &	GetObjectList () const
const RVC::OBJTYPESET &	GetObjTypeSet () const
bool	IsEmpty () const
ERRVALUE	Select (bool notify)
void	SetDelegateOnListChanged (DELEGATE_VOID_NOPARMS delegate)
void	SetDelegateOnObjectAdded (FastDelegate< void(const RVC::OBJITEM &, INT32)> delegate)
void	SetDelegateOnObjectRemoved (FastDelegate< void(INT32)> delegate)
void	SetDelegateOnObjectsAdded (DELEGATE_VOID_NOPARMS delegate)
void	SetDelegateOnObjectsAllRemoved (DELEGATE_VOID_NOPARMS delegate)
void	SetDelegateOnObjectSelected (FastDelegate< void(const RVC::OBJITEM &, INT32)> delegate)
void	SetObjectList (const RVC::OBJITEMLIST &ObjItemList)
Protected Member Functions
virtual void	v_OnListChanged ()
virtual void	v_OnObjectAdded (const RVC::OBJITEM &ObjItem, INT32 ItemNum)
virtual void	v_OnObjectRemoved (INT32 ItemNum)
virtual void	v_OnObjectsAdded ()
virtual void	v_OnObjectsAllRemoved ()
virtual void	v_OnObjectSelected (const RVC::OBJITEM &ObjItem, INT32 ItemNum)

Detailed Description

Form containing basic object selection list with "select", "remove", and "remove all" buttons.

Constructor & Destructor Documentation

RVC::UI::FORM_OBJECT_LIST::FORM_OBJECT_LIST ( )

Constructor.

virtual RVC::UI::FORM_OBJECT_LIST::~FORM_OBJECT_LIST ( ) [virtual]

Destructor.

Member Function Documentation

void RVC::UI::FORM_OBJECT_LIST::Clear ( bool notify )

Clears out all of the selected objects.

Parameters:

notify

Send notifications via virtual methods

ERRVALUE RVC::UI::FORM_OBJECT_LIST::Create	(	MGUI::LAYOUT_PANE_BASE &	ParentPane,
		const MISTRING &	promptstr,
		const RVC::OBJTYPESET &	ObjTypeSet,
		GETOBJFLAGS	GetObjFlags = `GETOBJFLAG_None`,
		RVC::GETOBJFILTER *	GetObjFilter = `0`,
		int	ListHeight = `5`,
		MGUI::LAYOUT_SIZEALIGN	sizealign = `MGUI::LAYOUT_SIZEALIGN_Expand`
	)

Create object list form.

Parameters:

	ParentPane	Parent pane
	promptstr	Prompt string to use with DlgGetObjects
	ObjTypeSet	Set of object types that are selectable
	GetObjFlags	Flags for DlgGetObjects
	GetObjFilter	Filter for DlgGetObjects
	ListHeight	Initial list box height

MGUI::LAYOUT_PANE& RVC::UI::FORM_OBJECT_LIST::GetBtnPane ( ) [inline]

const RVC::OBJITEM& RVC::UI::FORM_OBJECT_LIST::GetCurrentObject ( ) const

Get the current object, will return an empty OBJITEM if there is nothing in the list.

const RVC::OBJITEMLIST& RVC::UI::FORM_OBJECT_LIST::GetObjectList ( ) const [inline]

Get the list of objects in the list.

const RVC::OBJTYPESET& RVC::UI::FORM_OBJECT_LIST::GetObjTypeSet ( ) const [inline]

Get set of allowed object types.

bool RVC::UI::FORM_OBJECT_LIST::IsEmpty ( ) const [inline]

Is the list empty?

ERRVALUE RVC::UI::FORM_OBJECT_LIST::Select ( bool notify )

Select objects via form.

Behaves same as when 'Select' button pressed.

Parameters:

notify

Send notifications via virtual methods

void RVC::UI::FORM_OBJECT_LIST::SetDelegateOnListChanged ( DELEGATE_VOID_NOPARMS delegate ) [inline]

Set delegate to call for any change to objects in list.

void RVC::UI::FORM_OBJECT_LIST::SetDelegateOnObjectAdded ( FastDelegate< void(const RVC::OBJITEM &, INT32)> delegate ) [inline]

Set delegate to call for each object added to list.

Parameters:

delegate

Delegate parameters: object item, item index in list

void RVC::UI::FORM_OBJECT_LIST::SetDelegateOnObjectRemoved ( FastDelegate< void(INT32)> delegate ) [inline]

Set delegate to call when single object removed from list.

Parameters:

delegate

Delegate parameter: item index in list

void RVC::UI::FORM_OBJECT_LIST::SetDelegateOnObjectsAdded ( DELEGATE_VOID_NOPARMS delegate ) [inline]

Set delegate to call when objects added to list.

void RVC::UI::FORM_OBJECT_LIST::SetDelegateOnObjectsAllRemoved ( DELEGATE_VOID_NOPARMS delegate ) [inline]

Set delegate to call when all objects removed from list.

void RVC::UI::FORM_OBJECT_LIST::SetDelegateOnObjectSelected ( FastDelegate< void(const RVC::OBJITEM &, INT32)> delegate ) [inline]

Set delegate to call when object selected (highlighted) in list.

Parameters:

delegate

Delegate parameters: object item, item index in list

void RVC::UI::FORM_OBJECT_LIST::SetObjectList ( const RVC::OBJITEMLIST & ObjItemList )

Set the list of objects in the list Must be called before Create() method.

virtual void RVC::UI::FORM_OBJECT_LIST::v_OnListChanged ( ) [protected, virtual]

Called for any change to objects in list.