include/wx/univ/checklst.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/univ/checklst.h
   3 // Purpose:     wxCheckListBox class for wxUniversal
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     12.09.00
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Vadim Zeitlin
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_UNIV_CHECKLST_H_
  13 #define _WX_UNIV_CHECKLST_H_
  14
  15 // ----------------------------------------------------------------------------
  16 // actions
  17 // ----------------------------------------------------------------------------
  18
  19 #define wxACTION_CHECKLISTBOX_TOGGLE _T("toggle")
  20
  21 // ----------------------------------------------------------------------------
  22 // wxCheckListBox
  23 // ----------------------------------------------------------------------------
  24
  25 class WXDLLEXPORT wxCheckListBox : public wxCheckListBoxBase
  26 {
  27 public:
  28     // ctors
  29     wxCheckListBox() { Init(); }
  30
  31     wxCheckListBox(wxWindow *parent,
  32                    wxWindowID id,
  33                    const wxPoint& pos = wxDefaultPosition,
  34                    const wxSize& size = wxDefaultSize,
  35                    int nStrings = 0,
  36                    const wxString choices[] = NULL,
  37                    long style = 0,
  38                    const wxValidator& validator = wxDefaultValidator,
  39                    const wxString& name = wxListBoxNameStr)
  40     {
  41         Init();
  42
  43         Create(parent, id, pos, size, nStrings, choices, style, validator, name);
  44     }
  45     wxCheckListBox(wxWindow *parent,
  46                    wxWindowID id,
  47                    const wxPoint& pos,
  48                    const wxSize& size,
  49                    const wxArrayString& choices,
  50                    long style = 0,
  51                    const wxValidator& validator = wxDefaultValidator,
  52                    const wxString& name = wxListBoxNameStr);
  53
  54     bool Create(wxWindow *parent,
  55                 wxWindowID id,
  56                 const wxPoint& pos = wxDefaultPosition,
  57                 const wxSize& size = wxDefaultSize,
  58                 int nStrings = 0,
  59                 const wxString choices[] = (const wxString *) NULL,
  60                 long style = 0,
  61                 const wxValidator& validator = wxDefaultValidator,
  62                 const wxString& name = wxListBoxNameStr);
  63     bool Create(wxWindow *parent,
  64                 wxWindowID id,
  65                 const wxPoint& pos,
  66                 const wxSize& size,
  67                 const wxArrayString& choices,
  68                 long style = 0,
  69                 const wxValidator& validator = wxDefaultValidator,
  70                 const wxString& name = wxListBoxNameStr);
  71
  72     // implement check list box methods
  73     virtual bool IsChecked(unsigned int item) const;
  74     virtual void Check(unsigned int item, bool check = true);
  75
  76     // and input handling
  77     virtual bool PerformAction(const wxControlAction& action,
  78                                long numArg = -1l,
  79                                const wxString& strArg = wxEmptyString);
  80
  81     // override all methods which add/delete items to update m_checks array as
  82     // well
  83     virtual void Delete(unsigned int n);
  84
  85 protected:
  86     virtual int DoAppend(const wxString& item);
  87     virtual void DoInsertItems(const wxArrayString& items, unsigned int pos);
  88     virtual void DoSetItems(const wxArrayString& items, void **clientData);
  89     virtual void DoClear();
  90
  91     // draw the check items instead of the usual ones
  92     virtual void DoDrawRange(wxControlRenderer *renderer,
  93                              int itemFirst, int itemLast);
  94
  95     // take them also into account for size calculation
  96     virtual wxSize DoGetBestClientSize() const;
  97
  98     // common part of all ctors
  99     void Init();
 100
 101 private:
 102     // the array containing the checked status of the items
 103     wxArrayInt m_checks;
 104
 105     DECLARE_DYNAMIC_CLASS(wxCheckListBox)
 106 };
 107
 108 // ----------------------------------------------------------------------------
 109 // wxStdCheckListBoxInputHandler
 110 // ----------------------------------------------------------------------------
 111
 112 class WXDLLEXPORT wxStdCheckListboxInputHandler : public wxStdListboxInputHandler
 113 {
 114 public:
 115     wxStdCheckListboxInputHandler(wxInputHandler *inphand);
 116
 117     virtual bool HandleKey(wxInputConsumer *consumer,
 118                            const wxKeyEvent& event,
 119                            bool pressed);
 120     virtual bool HandleMouse(wxInputConsumer *consumer,
 121                              const wxMouseEvent& event);
 122 };
 123
 124 #endif // _WX_UNIV_CHECKLST_H_