include/wx/univ/checkbox.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/univ/checkbox.h
   3 // Purpose:     wxCheckBox declaration
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     07.09.00
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2000 SciTech Software, Inc. (www.scitechsoft.com)
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_UNIV_CHECKBOX_H_
  13 #define _WX_UNIV_CHECKBOX_H_
  14
  15 #include "wx/button.h" // for wxStdButtonInputHandler
  16
  17 // ----------------------------------------------------------------------------
  18 // the actions supported by wxCheckBox
  19 // ----------------------------------------------------------------------------
  20
  21 #define wxACTION_CHECKBOX_CHECK   _T("check")   // SetValue(true)
  22 #define wxACTION_CHECKBOX_CLEAR   _T("clear")   // SetValue(false)
  23 #define wxACTION_CHECKBOX_TOGGLE  _T("toggle")  // toggle the check state
  24
  25 // additionally it accepts wxACTION_BUTTON_PRESS and RELEASE
  26
  27 // ----------------------------------------------------------------------------
  28 // wxCheckBox
  29 // ----------------------------------------------------------------------------
  30
  31 // X11 headers may define this
  32 #ifdef Status
  33 #undef Status
  34 #endif
  35
  36 class WXDLLEXPORT wxCheckBox : public wxCheckBoxBase
  37 {
  38 public:
  39     // checkbox constants
  40     enum State
  41     {
  42         State_Normal,
  43         State_Pressed,
  44         State_Disabled,
  45         State_Current,
  46         State_Max
  47     };
  48
  49     enum Status
  50     {
  51         Status_Checked,
  52         Status_Unchecked,
  53         Status_3rdState,
  54         Status_Max
  55     };
  56
  57     // constructors
  58     wxCheckBox() { Init(); }
  59
  60     wxCheckBox(wxWindow *parent,
  61                wxWindowID id,
  62                const wxString& label,
  63                const wxPoint& pos = wxDefaultPosition,
  64                const wxSize& size = wxDefaultSize,
  65                long style = 0,
  66                const wxValidator& validator = wxDefaultValidator,
  67                const wxString& name = wxCheckBoxNameStr)
  68     {
  69         Init();
  70
  71         Create(parent, id, label, pos, size, style, validator, name);
  72     }
  73
  74     bool Create(wxWindow *parent,
  75                 wxWindowID id,
  76                 const wxString& label,
  77                 const wxPoint& pos = wxDefaultPosition,
  78                 const wxSize& size = wxDefaultSize,
  79                 long style = 0,
  80                 const wxValidator& validator = wxDefaultValidator,
  81                 const wxString& name = wxCheckBoxNameStr);
  82
  83     // implement the checkbox interface
  84     virtual void SetValue(bool value);
  85     virtual bool GetValue() const;
  86
  87     // set/get the bitmaps to use for the checkbox indicator
  88     void SetBitmap(const wxBitmap& bmp, State state, Status status);
  89     virtual wxBitmap GetBitmap(State state, Status status) const;
  90
  91     // wxCheckBox actions
  92     void Toggle();
  93     virtual void Press();
  94     virtual void Release();
  95     virtual void ChangeValue(bool value);
  96
  97     // overridden base class virtuals
  98     virtual bool IsPressed() const { return m_isPressed; }
  99
 100 protected:
 101     virtual void DoSet3StateValue(wxCheckBoxState WXUNUSED(state));
 102     virtual wxCheckBoxState DoGet3StateValue() const;
 103
 104     virtual bool PerformAction(const wxControlAction& action,
 105                                long numArg = -1,
 106                                const wxString& strArg = wxEmptyString);
 107     virtual void DoDraw(wxControlRenderer *renderer);
 108     virtual wxSize DoGetBestClientSize() const;
 109
 110     virtual bool CanBeHighlighted() const { return true; }
 111
 112     // get the size of the bitmap using either the current one or the default
 113     // one (query renderer then)
 114     virtual wxSize GetBitmapSize() const;
 115
 116     // common part of all ctors
 117     void Init();
 118
 119     // send command event notifying about the checkbox state change
 120     virtual void SendEvent();
 121
 122     // called when the checkbox becomes checked - radio button hook
 123     virtual void OnCheck();
 124
 125     // get the state corresponding to the flags (combination of wxCONTROL_XXX)
 126     wxCheckBox::State GetState(int flags) const;
 127
 128     // directly access the bitmaps array without trying to find a valid bitmap
 129     // to use as GetBitmap() does
 130     wxBitmap DoGetBitmap(State state, Status status) const
 131         { return m_bitmaps[state][status]; }
 132
 133     // get the current status
 134     Status GetStatus() const { return m_status; }
 135
 136 private:
 137     // the current check status
 138     Status m_status;
 139
 140     // the bitmaps to use for the different states
 141     wxBitmap m_bitmaps[State_Max][Status_Max];
 142
 143     // is the checkbox currently pressed?
 144     bool m_isPressed;
 145
 146     DECLARE_DYNAMIC_CLASS(wxCheckBox)
 147 };
 148
 149 // ----------------------------------------------------------------------------
 150 // wxStdCheckboxInputHandler: handles the mouse events for the check and radio
 151 // boxes (handling the keyboard input is simple, but its handling differs a
 152 // lot between GTK and MSW, so a new class should be derived for this)
 153 // ----------------------------------------------------------------------------
 154
 155 class WXDLLEXPORT wxStdCheckboxInputHandler : public wxStdButtonInputHandler
 156 {
 157 public:
 158     wxStdCheckboxInputHandler(wxInputHandler *inphand);
 159
 160     // we have to override this one as wxStdButtonInputHandler version works
 161     // only with the buttons
 162     virtual bool HandleActivation(wxInputConsumer *consumer, bool activated);
 163 };
 164
 165 #endif // _WX_UNIV_CHECKBOX_H_