RVC::UI::FORM_OBJECT_SINGLE Class Reference

Form to manage single object selection, containing button on text. More...

#include <rvc/uiformobjectsingle.h>

Inheritance diagram for RVC::UI::FORM_OBJECT_SINGLE:

[legend]

List of all members.

Public Member Functions
	FORM_OBJECT_SINGLE ()
virtual	~FORM_OBJECT_SINGLE ()
void	Clear (bool notify)
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, const MISTRING &label, const MISTRING &promptstr, const RVC::OBJTYPESET &ObjTypeSet, GETOBJFLAGS GetObjFlags=GETOBJFLAG_None, RVC::GETOBJFILTER *pGetObjFilter=0, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_FixedHeight)
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, const MISTRING &label, const MISTRING &promptstr, const RVC::OBJTYPESET &ObjTypeSet, int width, GETOBJFLAGS GetObjFlags=GETOBJFLAG_None, RVC::GETOBJFILTER *pGetObjFilter=0, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_FixedHeight)
const RVC::OBJITEM &	GetObjItem () const
ERRVALUE	Select (bool notify)
void	SetDelegateOnChangeSelected (DELEGATE_VOID_NOPARMS delegate)
void	SetObjItem (const RVC::OBJITEM &ObjItem, bool notify)

---

Detailed Description

Form to manage single object selection, containing button on text.

---

Constructor & Destructor Documentation

RVC::UI::FORM_OBJECT_SINGLE::FORM_OBJECT_SINGLE

(

)

Constructor.

virtual RVC::UI::FORM_OBJECT_SINGLE::~FORM_OBJECT_SINGLE

(

)

[virtual]

Destructor.

---

Member Function Documentation

void RVC::UI::FORM_OBJECT_SINGLE::Clear

(

bool

notify

)

Clears the selection.

Parameters:

notify

Notify

void RVC::UI::FORM_OBJECT_SINGLE::Create	(	MGUI::LAYOUT_PANE_BASE &	ParentPane,
		const MISTRING &	label,
		const MISTRING &	promptstr,
		const RVC::OBJTYPESET &	ObjTypeSet,
		GETOBJFLAGS	GetObjFlags = GETOBJFLAG_None,
		RVC::GETOBJFILTER *	pGetObjFilter = 0,
		MGUI::LAYOUT_SIZEALIGN	sizealign = MGUI::LAYOUT_SIZEALIGN_FixedHeight
	)

Create object list form with default width.

Parameters:

	ParentPane	Parent pane
	label	Label for button
	promptstr	Prompt string to use with DlgGetObjects
	ObjTypeSet	Set of object types that are selectable
	GetObjFlags	Flags for DlgGetObjects
	pGetObjFilter	Filter for DlgGetObjects

void RVC::UI::FORM_OBJECT_SINGLE::Create	(	MGUI::LAYOUT_PANE_BASE &	ParentPane,
		const MISTRING &	label,
		const MISTRING &	promptstr,
		const RVC::OBJTYPESET &	ObjTypeSet,
		int	width,
		GETOBJFLAGS	GetObjFlags = GETOBJFLAG_None,
		RVC::GETOBJFILTER *	pGetObjFilter = 0,
		MGUI::LAYOUT_SIZEALIGN	sizealign = MGUI::LAYOUT_SIZEALIGN_FixedHeight
	)

Create object list form.

Parameters:

	ParentPane	Parent pane
	label	Label for button
	promptstr	Prompt string to use with DlgGetObjects
	ObjTypeSet	Set of object types that are selectable
	width	Width in "em" characters
	GetObjFlags	Flags for DlgGetObjects
	pGetObjFilter	Filter for DlgGetObjects

const RVC::OBJITEM& RVC::UI::FORM_OBJECT_SINGLE::GetObjItem

(

)

const [inline]

Get selected object.

ERRVALUE RVC::UI::FORM_OBJECT_SINGLE::Select

(

bool

notify

)

Select object via form.

Behaves same as when 'Select' button pressed.

Parameters:

notify

Send notification to delegate after selection

void RVC::UI::FORM_OBJECT_SINGLE::SetDelegateOnChangeSelected

(

DELEGATE_VOID_NOPARMS

delegate

)

[inline]

Set delegate to call when change to selected object occurs.

void RVC::UI::FORM_OBJECT_SINGLE::SetObjItem	(	const RVC::OBJITEM &	ObjItem,
		bool	notify
	)

Set object.

Parameters:

	ObjItem	Object location to set
	notify	Send notification to delegate after selection

---

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

• rvc/uiformobjectsingle.h