1 /////////////////////////////////////////////////////////////////////////////// 2 // Name: wx/radiobox.h 3 // Purpose: wxRadioBox declaration 4 // Author: Vadim Zeitlin 5 // Modified by: 6 // Created: 10.09.00 7 // Copyright: (c) Vadim Zeitlin 8 // Licence: wxWindows licence 9 /////////////////////////////////////////////////////////////////////////////// 10 11 #ifndef _WX_RADIOBOX_H_BASE_ 12 #define _WX_RADIOBOX_H_BASE_ 13 14 #include "wx/defs.h" 15 16 #if wxUSE_RADIOBOX 17 18 #include "wx/ctrlsub.h" 19 20 #if wxUSE_TOOLTIPS 21 22 #include "wx/dynarray.h" 23 24 class WXDLLIMPEXP_FWD_CORE wxToolTip; 25 26 WX_DEFINE_EXPORTED_ARRAY_PTR(wxToolTip *, wxToolTipArray); 27 28 #endif // wxUSE_TOOLTIPS 29 30 extern WXDLLIMPEXP_DATA_CORE(const char) wxRadioBoxNameStr[]; 31 32 // ---------------------------------------------------------------------------- 33 // wxRadioBoxBase is not a normal base class, but rather a mix-in because the 34 // real wxRadioBox derives from different classes on different platforms: for 35 // example, it is a wxStaticBox in wxUniv and wxMSW but not in other ports 36 // ---------------------------------------------------------------------------- 37 38 class WXDLLIMPEXP_CORE wxRadioBoxBase : public wxItemContainerImmutable 39 { 40 public: 41 virtual ~wxRadioBoxBase(); 42 43 // change/query the individual radio button state 44 virtual bool Enable(unsigned int n, bool enable = true) = 0; 45 virtual bool Show(unsigned int n, bool show = true) = 0; 46 virtual bool IsItemEnabled(unsigned int n) const = 0; 47 virtual bool IsItemShown(unsigned int n) const = 0; 48 49 // return number of columns/rows in this radiobox GetColumnCount()50 unsigned int GetColumnCount() const { return m_numCols; } GetRowCount()51 unsigned int GetRowCount() const { return m_numRows; } 52 53 // return the next active (i.e. shown and not disabled) item above/below/to 54 // the left/right of the given one 55 int GetNextItem(int item, wxDirection dir, long style) const; 56 57 #if wxUSE_TOOLTIPS 58 // set the tooltip text for a radio item, empty string unsets any tooltip 59 void SetItemToolTip(unsigned int item, const wxString& text); 60 61 // get the individual items tooltip; returns NULL if none GetItemToolTip(unsigned int item)62 wxToolTip *GetItemToolTip(unsigned int item) const 63 { return m_itemsTooltips ? (*m_itemsTooltips)[item] : NULL; } 64 #endif // wxUSE_TOOLTIPS 65 66 #if wxUSE_HELP 67 // set helptext for a particular item, pass an empty string to erase it 68 void SetItemHelpText(unsigned int n, const wxString& helpText); 69 70 // retrieve helptext for a particular item, empty string means no help text 71 wxString GetItemHelpText(unsigned int n) const; 72 #else // wxUSE_HELP 73 // just silently ignore the help text, it's better than requiring using 74 // conditional compilation in all code using this function SetItemHelpText(unsigned int WXUNUSED (n),const wxString & WXUNUSED (helpText))75 void SetItemHelpText(unsigned int WXUNUSED(n), 76 const wxString& WXUNUSED(helpText)) 77 { 78 } 79 #endif // wxUSE_HELP 80 81 // returns the radio item at the given position or wxNOT_FOUND if none 82 // (currently implemented only under MSW and GTK) GetItemFromPoint(const wxPoint & WXUNUSED (pt))83 virtual int GetItemFromPoint(const wxPoint& WXUNUSED(pt)) const 84 { 85 return wxNOT_FOUND; 86 } 87 88 89 protected: wxRadioBoxBase()90 wxRadioBoxBase() 91 { 92 m_numCols = 93 m_numRows = 94 m_majorDim = 0; 95 96 #if wxUSE_TOOLTIPS 97 m_itemsTooltips = NULL; 98 #endif // wxUSE_TOOLTIPS 99 } 100 GetDefaultBorder()101 virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; } 102 103 // return the number of items in major direction (which depends on whether 104 // we have wxRA_SPECIFY_COLS or wxRA_SPECIFY_ROWS style) GetMajorDim()105 unsigned int GetMajorDim() const { return m_majorDim; } 106 107 // sets m_majorDim and also updates m_numCols/Rows 108 // 109 // the style parameter should be the style of the radiobox itself 110 void SetMajorDim(unsigned int majorDim, long style); 111 112 #if wxUSE_TOOLTIPS 113 // called from SetItemToolTip() to really set the tooltip for the specified 114 // item in the box (or, if tooltip is NULL, to remove any existing one). 115 // 116 // NB: this function should really be pure virtual but to avoid breaking 117 // the build of the ports for which it's not implemented yet we provide 118 // an empty stub in the base class for now 119 virtual void DoSetItemToolTip(unsigned int item, wxToolTip *tooltip); 120 121 // returns true if we have any item tooltips HasItemToolTips()122 bool HasItemToolTips() const { return m_itemsTooltips != NULL; } 123 #endif // wxUSE_TOOLTIPS 124 125 #if wxUSE_HELP 126 // Retrieve help text for an item: this is a helper for the implementation 127 // of wxWindow::GetHelpTextAtPoint() in the real radiobox class 128 wxString DoGetHelpTextAtPoint(const wxWindow *derived, 129 const wxPoint& pt, 130 wxHelpEvent::Origin origin) const; 131 #endif // wxUSE_HELP 132 133 private: 134 // the number of elements in major dimension (i.e. number of columns if 135 // wxRA_SPECIFY_COLS or the number of rows if wxRA_SPECIFY_ROWS) and also 136 // the number of rows/columns calculated from it 137 unsigned int m_majorDim, 138 m_numCols, 139 m_numRows; 140 141 #if wxUSE_TOOLTIPS 142 // array of tooltips for the individual items 143 // 144 // this array is initially NULL and initialized on first use 145 wxToolTipArray *m_itemsTooltips; 146 #endif 147 148 #if wxUSE_HELP 149 // help text associated with a particular item or empty string if none 150 wxArrayString m_itemsHelpTexts; 151 #endif // wxUSE_HELP 152 }; 153 154 #if defined(__WXUNIVERSAL__) 155 #include "wx/univ/radiobox.h" 156 #elif defined(__WXMSW__) 157 #include "wx/msw/radiobox.h" 158 #elif defined(__WXMOTIF__) 159 #include "wx/motif/radiobox.h" 160 #elif defined(__WXGTK20__) 161 #include "wx/gtk/radiobox.h" 162 #elif defined(__WXGTK__) 163 #include "wx/gtk1/radiobox.h" 164 #elif defined(__WXMAC__) 165 #include "wx/osx/radiobox.h" 166 #elif defined(__WXQT__) 167 #include "wx/qt/radiobox.h" 168 #endif 169 170 #endif // wxUSE_RADIOBOX 171 172 #endif // _WX_RADIOBOX_H_BASE_ 173