mgui/listbox.h

Go to the documentation of this file.

#ifndef  INC_MGUI_LISTBOX_H
#define  INC_MGUI_LISTBOX_H

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

#ifndef INC_MI32_INIDEFNS_H
#include <mi32/inidefns.h>
#endif

namespace MGUI {

#ifndef GENERATING_DOXYGEN_OUTPUT
class XMLIST;
#endif

//===================================================================================================================
class CTRL_LISTBOX : public MGUI::CTRL {
   public:

      enum STYLE {
         STYLE_Default =         0x00,
         STYLE_Sorted =          0x01,
         STYLE_MultiSelect =     0x02,       
         STYLE_ExtendedSelect =  0x04,       
         STYLE_ResizeIfPossible = 0x08,         
         STYLE_ExpandIfNeeded =  0x10        
         };

      CTRL_LISTBOX ();

      virtual ~CTRL_LISTBOX ();

      int AddItem (
         ID id,                                 
         const MISTRING& string,                
         bool resize = true                     
         );

      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    
         int height = 5,                        
         int width = 0,                         
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_Expand,
         STYLE style = STYLE_Default
         );

      void DeleteAllItems ();

      void DeleteItem (
         int index                              
         );

      void DeleteItemID (
         ID id                                  
         );

      void DeselectAllItems ();

      int GetCount () const;

      int GetIndexFromID (
         ID id
         ) const;

      ID GetItemID (
         int index                           
         ) const;

      MISTRING GetItemString (
         int index                           
         ) const;

      int GetSelectedCount () const;

      int GetSelectedItem () const;

      ID GetSelectedItemID () const;

      ERRVALUE GetSelectedItems (
         SIMPLE_ARRAY<int>& items
         ) const;

      int GetTopIndex () const;

      void IniRead (
         INIHANDLE IniHandle,                
         const char *IniGroup,               
         const char *IniField,               
         bool notify = true                  
         );

      void IniWrite (
         INIHANDLE IniHandle,                
         const char *IniGroup,               
         const char *IniField                
         ) const { ::IniWrite(IniHandle,IniGroup,IniField,static_cast<INT32>(GetSelectedItemID())); }

      int InsertItem (
         int index,                          
         ID id,                              
         const MISTRING& string              
         );

      bool IsItemSelected (
         int index                           
         ) const;

      void SetDelegateOnChangeSelection (
         DELEGATE_VOID_NOPARMS delegate
         ) { m_DelegateOnChangeSelection = delegate; }

      void SetDelegateOnDoubleClick (
         DELEGATE_VOID_NOPARMS delegate
         ) { m_DelegateOnDoubleClick = delegate; }

      void SetItemSelected (
         int index,                          
         bool select = true                  
         );

      void SetSelectedItem (
         int index                           
         );

      void SetSelectedItemID (
         ID id                               
         );

      void SetTopIndex (
         int index                           
         );
         
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      DELEGATE_VOID_NOPARMS m_DelegateOnChangeSelection;
      DELEGATE_VOID_NOPARMS m_DelegateOnDoubleClick;

      XMLIST *m_pxmlist;
      static void CB_ChangeSelection (Widget, CTRL_LISTBOX*, void*);
      static void CB_DoubleClick (Widget, CTRL_LISTBOX*, void*);

      void OnChangeSelection ();
      void OnDoubleClick ();

      CTRL_LISTBOX (const CTRL_LISTBOX&);
      CTRL_LISTBOX& operator= (const CTRL_LISTBOX&);
      #endif // GENERATING_DOXYGEN_OUTPUT

   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(MGUI::CTRL_LISTBOX::STYLE)
#endif

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

}  // End namespace MGUI

#endif   // INC_MGUI_LISTBOX_H

---