added another AddPane() call which allows the caller to add a new window at a certain...

[wxWidgets.git] / include / wx / radiobox.h

diff --git a/include/wx/radiobox.h b/include/wx/radiobox.h
index 41e7014aae766e48bfdd00d01061450ce717b437..540e4945c3c8aef58cd0134f507185ff4f189c34 100644 (file)
--- a/include/wx/radiobox.h
+++ b/include/wx/radiobox.h
@@ -16,6 +16,16 @@
 
 #include "wx/ctrlsub.h"
 
 
 #include "wx/ctrlsub.h"
 

+#if wxUSE_TOOLTIPS
+
+#include "wx/dynarray.h"
+
+class WXDLLEXPORT wxToolTip;
+
+WX_DEFINE_EXPORTED_ARRAY_PTR(wxToolTip *, wxToolTipArray);
+
+#endif // wxUSE_TOOLTIPS
+

 extern WXDLLEXPORT_DATA(const wxChar) wxRadioBoxNameStr[];
 
 // ----------------------------------------------------------------------------
 extern WXDLLEXPORT_DATA(const wxChar) wxRadioBoxNameStr[];
 
 // ----------------------------------------------------------------------------


@@ -27,14 +37,13 @@ extern WXDLLEXPORT_DATA(const wxChar) wxRadioBoxNameStr[];
 class WXDLLEXPORT wxRadioBoxBase : public wxItemContainerImmutable
 {
 public:
 class WXDLLEXPORT wxRadioBoxBase : public wxItemContainerImmutable
 {
 public:

+    virtual ~wxRadioBoxBase();
+

     // 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;
     // 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;

-
-    // NB: these functions are stubbed here for now but should become pure
-    //     virtual once all ports implement them
-    virtual bool IsItemEnabled(unsigned int WXUNUSED(n)) const { return true; }
-    virtual bool IsItemShown(unsigned int WXUNUSED(n)) const { return true; }
+    virtual bool IsItemEnabled(unsigned int n) const = 0;
+    virtual bool IsItemShown(unsigned int n) const = 0;

 
     // return number of columns/rows in this radiobox
     unsigned int GetColumnCount() const { return m_numCols; }
 
     // return number of columns/rows in this radiobox
     unsigned int GetColumnCount() const { return m_numCols; }


@@ -43,6 +52,37 @@ public:
     // return the item above/below/to the left/right of the given one
     int GetNextItem(int item, wxDirection dir, long style) const;
 
     // 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
+
+    // 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;
+    }
+

 
     // deprecated functions
     // --------------------
 
     // deprecated functions
     // --------------------


@@ -56,6 +96,10 @@ protected:
     wxRadioBoxBase()
     {
         m_majorDim = 0;
     wxRadioBoxBase()
     {
         m_majorDim = 0;

+
+#if wxUSE_TOOLTIPS
+        m_itemsTooltips = NULL;
+#endif // wxUSE_TOOLTIPS

     }
 
     // return the number of items in major direction (which depends on whether
     }
 
     // return the number of items in major direction (which depends on whether


@@ -67,6 +111,26 @@ protected:
     // the style parameter should be the style of the radiobox itself
     void SetMajorDim(unsigned int majorDim, long style);
 
     // the style parameter should be the style of the radiobox itself
     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
 
 private:
     // the number of elements in major dimension (i.e. number of columns if


@@ -75,6 +139,18 @@ private:
     unsigned 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__)
 };
 
 #if defined(__WXUNIVERSAL__)


@@ -99,5 +175,4 @@ private:
 
 #endif // wxUSE_RADIOBOX
 
 
 #endif // wxUSE_RADIOBOX
 

-#endif
-    // _WX_RADIOBOX_H_BASE_
+#endif // _WX_RADIOBOX_H_BASE_