MGUI::FORM_OBJECT_LIST Class Reference

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

#include <mgui/formobjl.h>

Inheritance diagram for MGUI::FORM_OBJECT_LIST:

[legend]List of all members.

Public Member Functions
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)
	FORM_OBJECT_LIST ()
const RVC::OBJITEM &	GetCurrentObject () const
const RVC::OBJITEMLIST &	GetObjectList () const
bool	IsEmpty () const
ERRVALUE	Select (bool notify)
virtual	~FORM_OBJECT_LIST ()
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.

Definition at line 70 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 (  bool  notify  )

Clears out all of the selected objects. Parameters: notify  Send notifications via virtual methods

ERRVALUE MGUI::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

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 [inline]

Get the list of objects in the list. Definition at line 102 of file formobjl.h.

bool MGUI::FORM_OBJECT_LIST::IsEmpty (   )  const [inline]

Is the list empty? Definition at line 106 of file formobjl.h.

ERRVALUE MGUI::FORM_OBJECT_LIST::Select (  bool  notify  )

Select objects via form. Behaves same as when 'Select' button pressed. Parameters: notify  Send notifications via virtual methods

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

Called for any change to objects in list.

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

Called for each object added to list.

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

Called when single object removed from list.

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

Called when objects added to list.

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

Called when all objects removed from list.

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

Called when object selected (highlighted) from list.

---

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

• mgui/formobjl.h

---