MGUI::FORM_OBJECT_LIST_T< _CT > Class Template Reference

Convenience template for OBJECT_LIST form to allow method in container class to be called. More...

#include <mgui/formobjl.h>

Inheritance diagram for MGUI::FORM_OBJECT_LIST_T< _CT >:

[legend]List of all members.

Public Member Functions
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, _CT *pContainer, void(_CT::*pfOnObjectSelected)(const RVC::OBJITEM &ObjItem), 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_T ()
void	SetObjectAdded (void(_CT::*ObjectAdded)(const RVC::OBJITEM &ObjItem, INT32 ItemNum))
void	SetObjectRemoved (void(_CT::*ObjectRemoved)(INT32 ItemNum))
void	SetObjectSelected (void(_CT::*ObjectSelected)(const RVC::OBJITEM &ObjItem, INT32 ItemNum))
void	SetObjectsRemoved (void(_CT::*ObjectsRemoved)())

---

Detailed Description

template<class _CT>
class MGUI::FORM_OBJECT_LIST_T< _CT >

Convenience template for OBJECT_LIST form to allow method in container class to be called.

This template allows a method in a 'container' class to be called when the button is pressed, rather than requiring that a subclass be defined with the OnPressed() virtual method overridden.

Definition at line 133 of file formobjl.h.

---

Constructor & Destructor Documentation

template<class _CT> MGUI::FORM_OBJECT_LIST_T< _CT >::FORM_OBJECT_LIST_T (   )  [inline]

Constructor. Definition at line 137 of file formobjl.h.

---

Member Function Documentation

template<class _CT> void MGUI::FORM_OBJECT_LIST_T< _CT >::Create (  MGUI::LAYOUT_PANE_BASE &  ParentPane, _CT *  pContainer, void(_CT::*  pfOnObjectSelected)(const RVC::OBJITEM &ObjItem), TEXTID  TextID, const RVC::OBJTYPESET &  ObjTypeSet, GETOBJFLAGS  GetObjFlags = GETOBJFLAG_None, RVC::GETOBJFILTER *  GetObjFilter = 0, MGUI::LAYOUT_SIZEALIGN  sizealign = MGUI::LAYOUT_SIZEALIGN_Expand )  [inline]

Create control with label from resource lookup. Parameters: ParentPane  Parent pane pContainer  Pointer to callback container class TextID  Callback function pointer Usually in the form of TEXTID_Prompt_XXXs_Input ObjTypeSet  Set of objects that are selectable Definition at line 148 of file formobjl.h.

template<class _CT> void MGUI::FORM_OBJECT_LIST_T< _CT >::SetObjectAdded (  void(_CT::*  ObjectAdded)(const RVC::OBJITEM &ObjItem, INT32 ItemNum)  )  [inline]

Set method to call when user adds an object to the list. Definition at line 164 of file formobjl.h.

template<class _CT> void MGUI::FORM_OBJECT_LIST_T< _CT >::SetObjectRemoved (  void(_CT::*  ObjectRemoved)(INT32 ItemNum)  )  [inline]

Set method to call when user removes an object from the list. Definition at line 169 of file formobjl.h.

template<class _CT> void MGUI::FORM_OBJECT_LIST_T< _CT >::SetObjectSelected (  void(_CT::*  ObjectSelected)(const RVC::OBJITEM &ObjItem, INT32 ItemNum)  )  [inline]

Set method to call when user selects an object from the list. Definition at line 174 of file formobjl.h.

template<class _CT> void MGUI::FORM_OBJECT_LIST_T< _CT >::SetObjectsRemoved (  void(_CT::*  ObjectsRemoved)()  )  [inline]

Set method to call when user removes all list items. Definition at line 179 of file formobjl.h.

---

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

• mgui/formobjl.h

---