MGUI::FORM_OBJECT_LIST Class Reference

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

#include <mgui/formobjl.h>

Inheritance diagram for MGUI::FORM_OBJECT_LIST:

[legend]List of all members.

Public Member Functions
void	Clear ()
ERRVALUE	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, TEXTID TextID, const RVC::OBJTYPESET &ObjTypeSet, GETOBJFLAGS GetObjFlags=GETOBJFLAG_None, RVC::GETOBJFILTER *GetObjFilter=0, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_Expand)
	FORM_OBJECT_LIST ()
const RVC::OBJITEM &	GetCurrentObject () const
const RVC::OBJITEMLIST &	GetObjectList () const
bool	IsEmpty () const
virtual	~FORM_OBJECT_LIST ()
Protected Member Functions
virtual void	v_OnObjectAdded (const RVC::OBJITEM &ObjItem, INT32 ItemNum)
virtual void	v_OnObjectRemoved (INT32 ItemNum)
virtual void	v_OnObjectSelected (const RVC::OBJITEM &ObjItem, INT32 ItemNum)
virtual void	v_OnObjectSelected (const RVC::OBJITEM &ObjItem)
virtual void	v_OnObjectsRemoved ()

---

Detailed Description

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

Definition at line 60 of file formobjl.h.

---

Constructor & Destructor Documentation

MGUI::FORM_OBJECT_LIST::FORM_OBJECT_LIST (   )

Constructor.

virtual MGUI::FORM_OBJECT_LIST::~FORM_OBJECT_LIST (   )  [virtual]

Destructor.

---

Member Function Documentation

void MGUI::FORM_OBJECT_LIST::Clear (   )

Clears out all of the selected objects.

ERRVALUE MGUI::FORM_OBJECT_LIST::Create (  MGUI::LAYOUT_PANE_BASE &  ParentPane, TEXTID  TextID, const RVC::OBJTYPESET &  ObjTypeSet, GETOBJFLAGS  GetObjFlags = GETOBJFLAG_None, RVC::GETOBJFILTER *  GetObjFilter = 0, MGUI::LAYOUT_SIZEALIGN  sizealign = MGUI::LAYOUT_SIZEALIGN_Expand )

Create. Parameters: ParentPane  Parent pane TextID  Usually in the form of TEXTID_Prompt_XXXs_Input ObjTypeSet  Set of objects that are selectable

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

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

const RVC::OBJITEMLIST& MGUI::FORM_OBJECT_LIST::GetObjectList (   )  const

Get the list of objects in the list.

bool MGUI::FORM_OBJECT_LIST::IsEmpty (   )  const

Is the list empty?

virtual void MGUI::FORM_OBJECT_LIST::v_OnObjectAdded (  const RVC::OBJITEM &  ObjItem, INT32  ItemNum )  [protected, virtual]

virtual void MGUI::FORM_OBJECT_LIST::v_OnObjectRemoved (  INT32  ItemNum  )  [protected, virtual]

virtual void MGUI::FORM_OBJECT_LIST::v_OnObjectSelected (  const RVC::OBJITEM &  ObjItem, INT32  ItemNum )  [protected, virtual]

virtual void MGUI::FORM_OBJECT_LIST::v_OnObjectSelected (  const RVC::OBJITEM &  ObjItem  )  [protected, virtual]

virtual void MGUI::FORM_OBJECT_LIST::v_OnObjectsRemoved (   )  [protected, virtual]

---

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

• mgui/formobjl.h

---