rvc/uiformobjectlist.h

Go to the documentation of this file.

#ifndef  INC_RVC_UIFORMOBJECTLIST_H
#define  INC_RVC_UIFORMOBJECTLIST_H

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

#ifndef  INC_RVC_OBJITEMLIST_H
#include <rvc/objitemlist.h>
#endif

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

#ifndef  INC_RVC_GETOBJFLAGS_H
#include <rvc/getobjflags.h>
#endif

namespace RVC {

class GETOBJFILTER;

namespace UI {
   
//===================================================================================================================
class FORM_OBJECT_LIST : public MGUI::FORM_COMPOSITE {
   public:
   
      FORM_OBJECT_LIST ();

      virtual ~FORM_OBJECT_LIST ();
         
      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
         );

      const RVC::OBJITEM& GetCurrentObject () const;
         
      const RVC::OBJITEMLIST& GetObjectList () const
         { return (m_ObjItemList); }

      MGUI::LAYOUT_PANE& GetBtnPane (
         ) { return (m_BtnPane); }

      const RVC::OBJTYPESET& GetObjTypeSet () const
         { return (m_ObjTypeSet); }

      bool IsEmpty () const
         { return (m_ObjItemList.IsEmpty()); }

      ERRVALUE Select (
         bool notify                   
         );
         
      void SetDelegateOnListChanged (
         DELEGATE_VOID_NOPARMS delegate
         ) { m_DelegateOnListChanged = delegate; }

      void SetDelegateOnObjectAdded (
         FastDelegate<void(const RVC::OBJITEM&, INT32)> delegate  
         ) { m_DelegateOnObjectAdded = delegate; }

      void SetDelegateOnObjectRemoved (
         FastDelegate<void(INT32)> delegate                       
         ) { m_DelegateOnObjectRemoved = delegate; }

      void SetDelegateOnObjectSelected (
         FastDelegate<void(const RVC::OBJITEM&, INT32)> delegate  
         ) { m_DelegateOnObjectSelected = delegate; }

      void SetDelegateOnObjectsAdded (
         DELEGATE_VOID_NOPARMS delegate
         ) { m_DelegateOnObjectsAdded = delegate; }

      void SetDelegateOnObjectsAllRemoved (
         DELEGATE_VOID_NOPARMS delegate
         ) { m_DelegateOnObjectsAllRemoved = delegate; }

      void SetObjectList (
         const RVC::OBJITEMLIST& ObjItemList
         );

   protected:

      virtual void v_OnListChanged ();

      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_OnObjectsAdded ();

      virtual void v_OnObjectsAllRemoved ();
      
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      static RVC::OBJITEM *s_pNullItem;
      DELEGATE_VOID_NOPARMS m_DelegateOnListChanged;
      FastDelegate<void(const RVC::OBJITEM&, INT32)> m_DelegateOnObjectAdded;
      FastDelegate<void(INT32)> m_DelegateOnObjectRemoved;
      FastDelegate<void(const RVC::OBJITEM&, INT32)> m_DelegateOnObjectSelected;
      DELEGATE_VOID_NOPARMS m_DelegateOnObjectsAdded;
      DELEGATE_VOID_NOPARMS m_DelegateOnObjectsAllRemoved;
      MGUI::CTRL_LISTBOX m_ListBox;
      MGUI::CTRL_PUSHBUTTON m_BtnSelect;
      MGUI::CTRL_PUSHBUTTON m_BtnRemove;
      MGUI::CTRL_PUSHBUTTON m_BtnRemoveAll;
      MGUI::LAYOUT_PANE m_BtnPane;
      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
   };
   
//===================================================================================================================
}     // End namespace UI
}     // End namespace RVC

#endif   // INC_RVC_UIFORMOBJECTLIST_H

---