include/wx/stubs/checklst.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        checklst.h
   3 // Purpose:     wxCheckListBox class - a listbox with checkable items
   4 //              Note: this is an optional class.
   5 // Author:      AUTHOR
   6 // Modified by:
   7 // Created:     ??/??/98
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) AUTHOR
  10 // Licence:     wxWindows licence
  11 ///////////////////////////////////////////////////////////////////////////////
  12
  13 #ifndef _WX_CHECKLST_H_
  14 #define _WX_CHECKLST_H_
  15
  16 #ifdef __GNUG__
  17 #pragma interface "checklst.h"
  18 #endif
  19
  20 typedef   unsigned int  uint;
  21
  22 class wxCheckListBoxItem; // fwd decl, define in checklst.cpp
  23
  24 class wxCheckListBox : public wxListBox
  25 {
  26   DECLARE_DYNAMIC_CLASS(wxCheckListBox)
  27 public:
  28   // ctors
  29   wxCheckListBox();
  30   wxCheckListBox(wxWindow *parent, wxWindowID id,
  31                  const wxPoint& pos = wxDefaultPosition,
  32                  const wxSize& size = wxDefaultSize,
  33                  int nStrings = 0,
  34                  const wxString choices[] = NULL,
  35                  long style = 0,
  36                  const wxValidator& validator = wxDefaultValidator,
  37                  const wxString& name = wxListBoxNameStr);
  38
  39   // items may be checked
  40   bool  IsChecked(uint uiIndex) const;
  41   void  Check(uint uiIndex, bool bCheck = TRUE);
  42
  43   // accessors
  44   uint  GetItemHeight() const { return m_nItemHeight; }
  45
  46 protected:
  47   // we create our items ourselves and they have non-standard size,
  48   // so we need to override these functions
  49   virtual wxOwnerDrawn *CreateItem(uint n);
  50
  51   // pressing space or clicking the check box toggles the item
  52   void OnChar(wxKeyEvent& event);
  53   void OnLeftClick(wxMouseEvent& event);
  54
  55 private:
  56   uint    m_nItemHeight;  // height of checklistbox items (the same for all)
  57
  58   DECLARE_EVENT_TABLE()
  59 };
  60
  61 #endif
  62     // _WX_CHECKLST_H_