include/wx/univ/radiobox.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/univ/radiobox.h
   3 // Purpose:     wxRadioBox declaration
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     11.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_RADIOBOX_H_
  13 #define _WX_UNIV_RADIOBOX_H_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "univradiobox.h"
  17 #endif
  18
  19 class WXDLLEXPORT wxRadioButton;
  20
  21 #include "wx/statbox.h"
  22 #include "wx/dynarray.h"
  23
  24 WX_DEFINE_EXPORTED_ARRAY_PTR(wxRadioButton *, wxArrayRadioButtons);
  25
  26 // ----------------------------------------------------------------------------
  27 // wxRadioBox: a box full of radio buttons
  28 // ----------------------------------------------------------------------------
  29
  30 class WXDLLEXPORT wxRadioBox : public wxStaticBox,
  31                                public wxRadioBoxBase
  32 {
  33 public:
  34     // wxRadioBox construction
  35     wxRadioBox() { Init(); }
  36
  37     wxRadioBox(wxWindow *parent,
  38                wxWindowID id,
  39                const wxString& title,
  40                const wxPoint& pos = wxDefaultPosition,
  41                const wxSize& size = wxDefaultSize,
  42                int n = 0, const wxString *choices = NULL,
  43                int majorDim = 0,
  44                long style = wxRA_SPECIFY_COLS,
  45                const wxValidator& val = wxDefaultValidator,
  46                const wxString& name = wxRadioBoxNameStr)
  47     {
  48         Init();
  49
  50         (void)Create(parent, id, title, pos, size, n, choices,
  51                      majorDim, style, val, name);
  52     }
  53     wxRadioBox(wxWindow *parent,
  54                wxWindowID id,
  55                const wxString& title,
  56                const wxPoint& pos,
  57                const wxSize& size,
  58                const wxArrayString& choices,
  59                int majorDim = 0,
  60                long style = wxRA_SPECIFY_COLS,
  61                const wxValidator& val = wxDefaultValidator,
  62                const wxString& name = wxRadioBoxNameStr);
  63
  64     bool Create(wxWindow *parent,
  65                 wxWindowID id,
  66                 const wxString& title,
  67                 const wxPoint& pos = wxDefaultPosition,
  68                 const wxSize& size = wxDefaultSize,
  69                 int n = 0, const wxString *choices = NULL,
  70                 int majorDim = 0,
  71                 long style = wxRA_SPECIFY_COLS,
  72                 const wxValidator& val = wxDefaultValidator,
  73                 const wxString& name = wxRadioBoxNameStr);
  74     bool Create(wxWindow *parent,
  75                 wxWindowID id,
  76                 const wxString& title,
  77                 const wxPoint& pos,
  78                 const wxSize& size,
  79                 const wxArrayString& choices,
  80                 int majorDim = 0,
  81                 long style = wxRA_SPECIFY_COLS,
  82                 const wxValidator& val = wxDefaultValidator,
  83                 const wxString& name = wxRadioBoxNameStr);
  84
  85     virtual ~wxRadioBox();
  86
  87     // implement wxRadioBox interface
  88     virtual void SetSelection(int n);
  89     virtual int GetSelection() const;
  90
  91     virtual int GetCount() const { return m_buttons.GetCount(); }
  92     virtual int GetColumnCount() const { return m_numCols; }
  93     virtual int GetRowCount() const { return m_numRows; }
  94
  95     virtual wxString GetString(int n) const;
  96     virtual void SetString(int n, const wxString& label);
  97
  98     virtual void Enable(int n, bool enable = true);
  99     virtual void Show(int n, bool show = true);
 100
 101     // we also override the wxControl methods to avoid virtual function hiding
 102     virtual bool Enable(bool enable = true);
 103     virtual bool Show(bool show = true);
 104     virtual wxString GetLabel() const;
 105     virtual void SetLabel(const wxString& label);
 106
 107 #if wxUSE_TOOLTIPS
 108     virtual void DoSetToolTip( wxToolTip *tip );
 109 #endif // wxUSE_TOOLTIPS
 110
 111     // wxUniversal-only methods
 112
 113     // another Append() version
 114     void Append(int n, const wxString *choices);
 115
 116     // implementation only: called by wxRadioHookHandler
 117     void OnRadioButton(wxEvent& event);
 118     bool OnKeyDown(wxKeyEvent& event);
 119
 120 protected:
 121     // override the base class methods dealing with window positioning/sizing
 122     // as we must move/size the buttons as well
 123     virtual void DoMoveWindow(int x, int y, int width, int height);
 124     virtual wxSize DoGetBestClientSize() const;
 125
 126     // generate a radiobutton click event for the current item
 127     void SendRadioEvent();
 128
 129     // common part of all ctors
 130     void Init();
 131
 132     // check that the index is valid
 133     bool IsValid(int n) const { return n >= 0 && n < GetCount(); }
 134
 135     // sets m_majorDim and calculate m_numCols and m_numRows
 136     void SetMajorDim(int majorDim);
 137
 138     // calculate the max size of all buttons
 139     wxSize GetMaxButtonSize() const;
 140
 141     // the currently selected radio button or -1
 142     int m_selection;
 143
 144     // the parameters defining the button layout: majorDim meaning depends on
 145     // the style and is the (max) number of columns if it includes
 146     // wxRA_SPECIFY_COLS and is the (max) number of rows if it includes
 147     // wxRA_SPECIFY_ROWS - the number of rows and columns is calculated from
 148     // it
 149     int m_majorDim,
 150         m_numCols,
 151         m_numRows;
 152
 153     // all radio buttons
 154     wxArrayRadioButtons m_buttons;
 155
 156     // the event handler which is used to translate radiobutton events into
 157     // radiobox one
 158     wxEvtHandler *m_evtRadioHook;
 159
 160 private:
 161     DECLARE_DYNAMIC_CLASS(wxRadioBox)
 162 };
 163
 164 #endif // _WX_UNIV_RADIOBOX_H_