X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1be7a35c5ec31b6cfcab9d969c7969586441a945..92159e3d769551d78d8f48f438fc8c40655d23d2:/include/wx/radiobox.h diff --git a/include/wx/radiobox.h b/include/wx/radiobox.h index 0cbb947156..153927aec8 100644 --- a/include/wx/radiobox.h +++ b/include/wx/radiobox.h @@ -16,7 +16,17 @@ #include "wx/ctrlsub.h" -extern WXDLLEXPORT_DATA(const wxChar) wxRadioBoxNameStr[]; +#if wxUSE_TOOLTIPS + +#include "wx/dynarray.h" + +class WXDLLIMPEXP_FWD_CORE wxToolTip; + +WX_DEFINE_EXPORTED_ARRAY_PTR(wxToolTip *, wxToolTipArray); + +#endif // wxUSE_TOOLTIPS + +extern WXDLLIMPEXP_DATA_CORE(const char) wxRadioBoxNameStr[]; // ---------------------------------------------------------------------------- // wxRadioBoxBase is not a normal base class, but rather a mix-in because the @@ -24,57 +34,119 @@ extern WXDLLEXPORT_DATA(const wxChar) wxRadioBoxNameStr[]; // example, it is a wxStaticBox in wxUniv and wxMSW but not in other ports // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxRadioBoxBase : public wxItemContainerImmutable +class WXDLLIMPEXP_CORE wxRadioBoxBase : public wxItemContainerImmutable { public: - // change/query the individual radio button state - virtual bool Enable(int n, bool enable = true) = 0; - virtual bool Show(int n, bool show = true) = 0; + virtual ~wxRadioBoxBase(); - // NB: these functions are stubbed here for now but should become pure - // virtual once all ports implement them - virtual bool IsItemEnabled(int WXUNUSED(n)) const { return true; } - virtual bool IsItemShown(int WXUNUSED(n)) const { return true; } + // change/query the individual radio button state + virtual bool Enable(unsigned int n, bool enable = true) = 0; + virtual bool Show(unsigned int n, bool show = true) = 0; + virtual bool IsItemEnabled(unsigned int n) const = 0; + virtual bool IsItemShown(unsigned int n) const = 0; // return number of columns/rows in this radiobox - int GetColumnCount() const { return m_numCols; } - int GetRowCount() const { return m_numRows; } + unsigned int GetColumnCount() const { return m_numCols; } + unsigned int GetRowCount() const { return m_numRows; } // return the item above/below/to the left/right of the given one int GetNextItem(int item, wxDirection dir, long style) const; +#if wxUSE_TOOLTIPS + // set the tooltip text for a radio item, empty string unsets any tooltip + void SetItemToolTip(unsigned int item, const wxString& text); + + // get the individual items tooltip; returns NULL if none + wxToolTip *GetItemToolTip(unsigned int item) const + { return m_itemsTooltips ? (*m_itemsTooltips)[item] : NULL; } +#endif // wxUSE_TOOLTIPS + +#if wxUSE_HELP + // set helptext for a particular item, pass an empty string to erase it + void SetItemHelpText(unsigned int n, const wxString& helpText); + + // retrieve helptext for a particular item, empty string means no help text + wxString GetItemHelpText(unsigned int n) const; +#else // wxUSE_HELP + // just silently ignore the help text, it's better than requiring using + // conditional compilation in all code using this function + void SetItemHelpText(unsigned int WXUNUSED(n), + const wxString& WXUNUSED(helpText)) + { + } +#endif // wxUSE_HELP - // deprecated functions - // -------------------- + // returns the radio item at the given position or wxNOT_FOUND if none + // (currently implemented only under MSW and GTK) + virtual int GetItemFromPoint(const wxPoint& WXUNUSED(pt)) const + { + return wxNOT_FOUND; + } -#if WXWIN_COMPATIBILITY_2_4 - wxDEPRECATED( int GetNumberOfRowsOrCols() const ); - wxDEPRECATED( void SetNumberOfRowsOrCols(int n) ); -#endif // WXWIN_COMPATIBILITY_2_4 protected: wxRadioBoxBase() { + m_numCols = + m_numRows = m_majorDim = 0; + +#if wxUSE_TOOLTIPS + m_itemsTooltips = NULL; +#endif // wxUSE_TOOLTIPS } + virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; } + // return the number of items in major direction (which depends on whether // we have wxRA_SPECIFY_COLS or wxRA_SPECIFY_ROWS style) - int GetMajorDim() const { return m_majorDim; } + unsigned int GetMajorDim() const { return m_majorDim; } // sets m_majorDim and also updates m_numCols/Rows // // the style parameter should be the style of the radiobox itself - void SetMajorDim(int majorDim, long style); + void SetMajorDim(unsigned int majorDim, long style); +#if wxUSE_TOOLTIPS + // called from SetItemToolTip() to really set the tooltip for the specified + // item in the box (or, if tooltip is NULL, to remove any existing one). + // + // NB: this function should really be pure virtual but to avoid breaking + // the build of the ports for which it's not implemented yet we provide + // an empty stub in the base class for now + virtual void DoSetItemToolTip(unsigned int item, wxToolTip *tooltip); + + // returns true if we have any item tooltips + bool HasItemToolTips() const { return m_itemsTooltips != NULL; } +#endif // wxUSE_TOOLTIPS + +#if wxUSE_HELP + // Retrieve help text for an item: this is a helper for the implementation + // of wxWindow::GetHelpTextAtPoint() in the real radiobox class + wxString DoGetHelpTextAtPoint(const wxWindow *derived, + const wxPoint& pt, + wxHelpEvent::Origin origin) const; +#endif // wxUSE_HELP private: // the number of elements in major dimension (i.e. number of columns if // wxRA_SPECIFY_COLS or the number of rows if wxRA_SPECIFY_ROWS) and also // the number of rows/columns calculated from it - int m_majorDim, - m_numCols, - m_numRows; + unsigned int m_majorDim, + m_numCols, + m_numRows; + +#if wxUSE_TOOLTIPS + // array of tooltips for the individual items + // + // this array is initially NULL and initialized on first use + wxToolTipArray *m_itemsTooltips; +#endif + +#if wxUSE_HELP + // help text associated with a particular item or empty string if none + wxArrayString m_itemsHelpTexts; +#endif // wxUSE_HELP }; #if defined(__WXUNIVERSAL__) @@ -99,5 +171,4 @@ private: #endif // wxUSE_RADIOBOX -#endif - // _WX_RADIOBOX_H_BASE_ +#endif // _WX_RADIOBOX_H_BASE_