mgui/formchecklist.h

Go to the documentation of this file.

#ifndef  INC_MGUI_FORMCHECKLIST_H
#define  INC_MGUI_FORMCHECKLIST_H

#ifndef INC_MGUI_FORM_H
#include <mgui/form.h>
#endif

#ifndef INC_MI32_MISTRING_H
#include <mi32/mistring.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
class BITSET;
namespace MGUI {
   class LAYOUT_PANE_BASE;
   }
#endif


namespace MGUI {

//===================================================================================================================

class FORM_CHECKLIST : public MGUI::FORM_COMPOSITE {
   public:
   
      enum STYLES {
         STYLE_Default =            0x00, 
         STYLE_FirstIsExclusive =   0x01, 
         STYLE_AtLeastOne =         0x02, 
         STYLE_OnlyOne =            0x04, 
         STYLE_ShowScrollbar =      0x08, 
         STYLE_ShowFrame =          0x10, 
         };

      FORM_CHECKLIST ();

      virtual ~FORM_CHECKLIST ();

      UINT16 AddItem (
         ID id,                                 
         const MISTRING& label,                 
         bool selected = false                  
         );

      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    
         int rows,                              
         int columns = 1,                       
         STYLES Style = STYLE_Default,
         MGUI::LAYOUT_SIZEALIGN SizeAlign = MGUI::LAYOUT_SIZEALIGN_Expand
         );

      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    
         const MISTRING& ColumnLabel,           
         int rows,                              
         int columns = 1,                       
         STYLES Style = STYLE_Default,
         MGUI::LAYOUT_SIZEALIGN SizeAlign = MGUI::LAYOUT_SIZEALIGN_Expand
         );

      void DeleteAllItems (
         );

      void DeleteItem (
         UINT16 index                           
         );

      void DeleteItemID (
         ID id                                  
         );

      UINT16 GetCount (
         ) const;

      UINT16 GetIndexFromID (
         ID id                                  
         ) const;

      ID GetItemID (
         UINT16 index                           
         ) const;

      MISTRING GetItemString (
         UINT16 index                           
         ) const;

      UINT16 GetSelectedCount (
         ) const;
         
      const BITSET& GetSelectedSet (
         ) const;

      UINT16 InsertItem (
         UINT16 index,                          
         ID id,                                 
         const MISTRING& string,                
         bool selected = false                  
         );

      bool IsItemSelected (
         UINT16 index                           
         ) const;

      bool IsItemSelectedID (
         ID id                                  
         ) const;

      void SetAllSelected (
         bool selected,
         bool notify = true
         );

      void SetDelegateOnChangeSelection (
         DELEGATE_VOID_NOPARMS delegate
         );

      bool SetItemSelected (
         UINT16 index,                          
         bool selected,
         bool notify = true
         );

      bool SetItemSelectedID (
         ID id,                                 
         bool selected,
         bool notify = true
         );

      void SizeToContentWidth (
         );

      virtual void SetEnabled (bool enabled);

      virtual void SetVisible (bool visible);

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class PRIV;
      PRIV *m_pPriv;

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

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(FORM_CHECKLIST::STYLES);
#endif

//===================================================================================================================

}  // End namespace MGUI

#endif   // INC_MGUI_FORMCHECKLIST_H

---