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.9 2005/06/22 14:31:45 mju Exp $
 *
 * $Log: formobjl.h_v $
 * Revision 1.9  2005/06/22 14:31:45  mju
 * Use ptr for null item to avoid static constructor.
 *
 * Revision 1.8  2005/03/08 14:31:16  mju
 * Standardize template to specify container in ctor, remove Create method, rename setFunc methods.
 * Use MISTRING for create method.
 * Add Select method and notify request to clear().
 * Add onListChanged.
 * Remove redundant onObjectSelected.
 *
 * 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" buttons.
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 (
         bool notify                   //!< Send notifications via virtual methods
         );

      //! Create object list form.
      ERRVALUE Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,          //!< Parent pane
         const MISTRING& promptstr,                   //!< Prompt string to use with DlgGetObjects
         const RVC::OBJTYPESET& ObjTypeSet,           //!< Set of object types that are selectable
         GETOBJFLAGS GetObjFlags = GETOBJFLAG_None,   //!< Flags for DlgGetObjects
         RVC::GETOBJFILTER* GetObjFilter = 0,         //!< Filter for DlgGetObjects
         int ListHeight = 5,                          //!< Initial list box height
         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 { return (m_ObjItemList); }

      //! Is the list empty?        
      bool IsEmpty (
         ) const { return (m_ObjItemList.IsEmpty()); }

      //! Select objects via form.
      //! Behaves same as when 'Select' button pressed.
      ERRVALUE Select (
         bool notify                   //!< Send notifications via virtual methods
         );
         
   protected:

      //! Called for any change to objects in list.
      virtual void v_OnListChanged ();

      //! Called for each object added to list.
      virtual void v_OnObjectAdded (const RVC::OBJITEM& ObjItem, INT32 ItemNum);

      //! Called when single object removed from list.
      virtual void v_OnObjectRemoved (INT32 ItemNum);

      //! Called when object selected (highlighted) from list.
      virtual void v_OnObjectSelected (const RVC::OBJITEM& ObjItem, INT32 ItemNum);

      //! Called when objects added to list.
      virtual void v_OnObjectsAdded ();

      //! Called when all objects removed from list.
      virtual void v_OnObjectsAllRemoved ();
      
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      static RVC::OBJITEM *s_pNullItem;
      MGUI::CTRL_LISTBOX_T<FORM_OBJECT_LIST> m_ListBox;
      MGUI::CTRL_PUSHBUTTON_T<FORM_OBJECT_LIST> m_BtnSelect;
      MGUI::CTRL_PUSHBUTTON_T<FORM_OBJECT_LIST> m_BtnRemove;
      MGUI::CTRL_PUSHBUTTON_T<FORM_OBJECT_LIST> m_BtnRemoveAll;
      RVC::OBJITEMLIST m_ObjItemList;
      MISTRING m_PromptStr;
      RVC::OBJTYPESET m_ObjTypeSet;
      GETOBJFLAGS m_GetObjFlags;
      RVC::GETOBJFILTER* m_GetObjFilter;

      void OnListSelection ();
      void OnBtnRemove ();
      void OnBtnRemoveAll ();
      void OnBtnSelect ();

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

//-------------------------------------------------------------------------------------------------------------------
//! Convenience template for FORM_OBJECT_LIST to allow method in container class to be called.
//! This template allows a method in a 'container' class to be called
//! rather than requiring that a subclass be defined with virtual method overridden.
template <class _CT> class FORM_OBJECT_LIST_T : public MGUI::FORM_OBJECT_LIST {
   public:

      //! Constructor.
      FORM_OBJECT_LIST_T (
         _CT *pContainer               //!< Pointer to container
         ) : 
         m_pContainer(pContainer),
         m_pfOnListChanged(0),
         m_pfOnObjectAdded(0),
         m_pfOnObjectRemoved(0),
         m_pfOnObjectSelected(0),
         m_pfOnObjectsAdded(0),
         m_pfOnObjectsAllRemoved(0)
         { }

      //! Set container when not convenient to do in constructor.
      void SetContainer (
         _CT *pContainer
         ) { m_pContainer = pContainer; }

      //! Set method to call when user makes any change to list items.
      void SetFuncListChanged (
         void (_CT::*pfListChanged)()
         ) { m_pfOnListChanged = pfListChanged; };

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

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

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

      //! Set method to call when user adds list items
      void SetFuncObjectsAdded (
         void (_CT::*pfObjectsAdded)()
         ) { m_pfOnObjectsAdded = pfObjectsAdded; };

      //! Set method to call when user removes all list items
      void SetFuncObjectsAllRemoved (
         void (_CT::*pfObjectsAllRemoved)()
         ) { m_pfOnObjectsAllRemoved = pfObjectsAllRemoved; };

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

      virtual void v_OnListChanged () { if (m_pfOnListChanged != 0) (m_pContainer->*m_pfOnListChanged)(); }
      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, INT32 ItemNum) { if (m_pfOnObjectSelected != 0) (m_pContainer->*m_pfOnObjectSelected)(ObjItem, ItemNum); }
      virtual void v_OnObjectsAdded () { if (m_pfOnObjectsAdded != 0) (m_pContainer->*m_pfOnObjectsAdded)(); }
      virtual void v_OnObjectsAllRemoved () { if (m_pfOnObjectsAllRemoved != 0) (m_pContainer->*m_pfOnObjectsAllRemoved)(); }
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

}     // End of MGUI namespace

#endif   // INC_MGUI_FORMOBJL_H

---