mgui/formobjl.h

Go to the documentation of this file.

/**
 * \file mgui/formobjl.h
 * \brief MGUI::FORM_OBJECT_LIST class definitions
 *
 * \if NODOC
 * $Id: formobjl.h_v 1.7 2003/10/03 19:58:19 linux32build!build Exp $
 *
 * $Log: formobjl.h_v $
 * Revision 1.7  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.6  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.5  2003/05/22 20:28:34  scowan
 * If on object selected with two parms is null, call the one parm version.
 *
 * Revision 1.4  2003/04/24 15:49:44  scowan
 * Added virtual methods.
 *
 * Revision 1.3  2003/04/09 20:50:26  dwilliss
 * Don't use _T in templates.  Mac's ctype.h defines a global _T
 *
 * Revision 1.2  2003/02/27 15:49:50  scowan
 * Changed to pass all parameters in the create method.
 *
 * Revision 1.1  2003/02/27 01:24:16  scowan
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MGUI_FORMOBJL_H
#define  INC_MGUI_FORMOBJL_H

#ifndef  INC_MGUI_CTRL_H
#include <mgui/ctrl.h>
#endif

#ifndef  INC_MGUI_LISTBOX_H
#include <mgui/listbox.h>
#endif

#ifndef  INC_MI32_RVCDEFNS_H
#include <mi32/rvcdefns.h>
#endif

#ifndef  INC_RVC_OTYPESET_H
#include <rvc/otypeset.h>
#endif

namespace RVC {
   class GETOBJFILTER;
   }

namespace MGUI {
   
//===================================================================================================================
//! Form containing basic object selection list with "select", "remove", and "remove all"
class FORM_OBJECT_LIST : public MGUI::FORM_COMPOSITE {
   public:
   
      //! Constructor.
      FORM_OBJECT_LIST (
         );

      //! Destructor.
      virtual ~FORM_OBJECT_LIST (
         );
         
      //! Clears out all of the selected objects
      void Clear (
         );

      //! Create
      ERRVALUE Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,          //!< Parent pane
         TEXTID TextID,                               //!< Usually in the form of TEXTID_Prompt_XXXs_Input
         const RVC::OBJTYPESET& ObjTypeSet,           //!< Set of objects that are selectable
         GETOBJFLAGS GetObjFlags = GETOBJFLAG_None,
         RVC::GETOBJFILTER* GetObjFilter = 0,
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_Expand
         );

      //! Get the current object, will return an empty OBJITEM if there is nothing in the list
      const RVC::OBJITEM& GetCurrentObject (
         ) const;
         
      //! Get the list of objects in the list         
      const RVC::OBJITEMLIST& GetObjectList (
         ) const;

      //! Is the list empty?        
      bool IsEmpty (
         ) const;
         
   protected:
      virtual void v_OnObjectAdded (const RVC::OBJITEM& ObjItem, INT32 ItemNum);
      virtual void v_OnObjectRemoved (INT32 ItemNum);
      virtual void v_OnObjectSelected (const RVC::OBJITEM& ObjItem);
      virtual void v_OnObjectSelected (const RVC::OBJITEM& ObjItem, INT32 ItemNum);
      virtual void v_OnObjectsRemoved ();
      
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      MGUI::CTRL_LISTBOX_T<FORM_OBJECT_LIST> m_ListBox;
      MGUI::LAYOUT_PANE m_SelectButtons;
      MGUI::CTRL_PUSHBUTTON_T<FORM_OBJECT_LIST> m_Select;
      MGUI::CTRL_PUSHBUTTON_T<FORM_OBJECT_LIST> m_Remove;
      MGUI::CTRL_PUSHBUTTON_T<FORM_OBJECT_LIST> m_RemoveAll;
      RVC::OBJITEMLIST m_ObjItemList;
      RVC::OBJITEM m_NullItem;
      TEXTID m_TextID;
      RVC::OBJTYPESET m_ObjTypeSet;
      GETOBJFLAGS m_GetObjFlags;
      RVC::GETOBJFILTER* m_GetObjFilter;

      void OnChangeSelection ();
      void OnRemovePressed ();
      void OnRemoveAllPressed ();
      void OnSelectPressed ();

      FORM_OBJECT_LIST (const FORM_OBJECT_LIST&);
      FORM_OBJECT_LIST& operator= (const FORM_OBJECT_LIST&);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };
   

//-------------------------------------------------------------------------------------------------------------------
//! 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.
template <class _CT> class FORM_OBJECT_LIST_T : public MGUI::FORM_OBJECT_LIST {
   public:

      //! Constructor.
      FORM_OBJECT_LIST_T (
         ) : 
         m_pContainer(0), 
         m_pfOnObjectAdded(0),
         m_pfOnObjectRemoved(0),
         m_pfOnObjectSelected(0),
         m_pfOnObjectSelectedNum(0),
         m_pfOnObjectsRemoved(0)
         {}

      //! Create control with label from resource lookup.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         _CT *pContainer,                       //!< Pointer to callback container class
         void (_CT::*pfOnObjectSelected)(const RVC::OBJITEM& ObjItem),        //! Callback function pointer
         TEXTID TextID,                               //!< Usually in the form of TEXTID_Prompt_XXXs_Input
         const RVC::OBJTYPESET& ObjTypeSet,           //!< Set of objects that are selectable
         GETOBJFLAGS GetObjFlags = GETOBJFLAG_None,
         RVC::GETOBJFILTER* GetObjFilter = 0,
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_Expand
         ) {
         m_pContainer = pContainer;
         m_pfOnObjectSelected = pfOnObjectSelected;
         FORM_OBJECT_LIST::Create(ParentPane, TextID, ObjTypeSet, GetObjFlags, GetObjFilter, sizealign);
         }

      //! Set method to call when user adds an object to the list
      void SetObjectAdded (
         void (_CT::*ObjectAdded)(const RVC::OBJITEM& ObjItem, INT32 ItemNum)
         ) { m_pfOnObjectAdded = ObjectAdded; };

      //! Set method to call when user removes an object from the list
      void SetObjectRemoved (
         void (_CT::*ObjectRemoved)(INT32 ItemNum)
         ) { m_pfOnObjectRemoved = ObjectRemoved; };

      //! Set method to call when user selects an object from the list
      void SetObjectSelected (
         void (_CT::*ObjectSelected)(const RVC::OBJITEM& ObjItem, INT32 ItemNum)
         ) { m_pfOnObjectSelectedNum = ObjectSelected; };

      //! Set method to call when user removes all list items
      void SetObjectsRemoved (
         void (_CT::*ObjectsRemoved)()
         ) { m_pfOnObjectsRemoved = ObjectsRemoved; };

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      _CT *m_pContainer;
      void (_CT::*m_pfOnObjectAdded)(const RVC::OBJITEM& ObjItem, INT32 ItemNum);
      void (_CT::*m_pfOnObjectRemoved)(INT32 ItemNum);
      void (_CT::*m_pfOnObjectSelected)(const RVC::OBJITEM& ObjItem);
      void (_CT::*m_pfOnObjectSelectedNum)(const RVC::OBJITEM& ObjItem, INT32 ItemNum);
      void (_CT::*m_pfOnObjectsRemoved)();

      virtual void v_OnObjectAdded (const RVC::OBJITEM& ObjItem, INT32 ItemNum) { if (m_pfOnObjectAdded != 0) (m_pContainer->*m_pfOnObjectAdded)(ObjItem, ItemNum); }
      virtual void v_OnObjectRemoved (INT32 ItemNum) { if (m_pfOnObjectRemoved != 0) (m_pContainer->*m_pfOnObjectRemoved)(ItemNum); }
      virtual void v_OnObjectSelected (const RVC::OBJITEM& ObjItem) { (m_pContainer->*m_pfOnObjectSelected)(ObjItem); }
      virtual void v_OnObjectSelected (const RVC::OBJITEM& ObjItem, INT32 ItemNum) { if (m_pfOnObjectSelectedNum != 0) {(m_pContainer->*m_pfOnObjectSelectedNum)(ObjItem, ItemNum);} else { (m_pContainer->*m_pfOnObjectSelected)(ObjItem); }}
      virtual void v_OnObjectsRemoved () { if (m_pfOnObjectsRemoved != 0) (m_pContainer->*m_pfOnObjectsRemoved)(); }
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

}     // End of MGUI namespace

#endif   // INC_MGUI_FORMOBJL_H

---