Minor corrections to wxFlexGridSizer ctor documentation.

[wxWidgets.git] / src / common / radiocmn.cpp

diff --git a/src/common/radiocmn.cpp b/src/common/radiocmn.cpp
index 1703e168a17ece2732b67e3937b286c96a627aac..766bd52109f7b6483367eec2264c1b953d54fe6f 100644 (file)
--- a/src/common/radiocmn.cpp
+++ b/src/common/radiocmn.cpp
@@ -34,13 +34,17 @@
     #include "wx/tooltip.h"
 #endif // wxUSE_TOOLTIPS
 
     #include "wx/tooltip.h"
 #endif // wxUSE_TOOLTIPS
 

+#if wxUSE_HELP
+    #include "wx/cshelp.h"
+#endif
+

 // ============================================================================
 // implementation
 // ============================================================================
 
 void wxRadioBoxBase::SetMajorDim(unsigned int majorDim, long style)
 {
 // ============================================================================
 // implementation
 // ============================================================================
 
 void wxRadioBoxBase::SetMajorDim(unsigned int majorDim, long style)
 {

-    wxCHECK_RET( majorDim != 0, _T("major radiobox dimension can't be 0") );
+    wxCHECK_RET( majorDim != 0, wxT("major radiobox dimension can't be 0") );

 
     m_majorDim = majorDim;
 
 
     m_majorDim = majorDim;
 


@@ -60,96 +64,106 @@ void wxRadioBoxBase::SetMajorDim(unsigned int majorDim, long style)
 
 int wxRadioBoxBase::GetNextItem(int item, wxDirection dir, long style) const
 {
 
 int wxRadioBoxBase::GetNextItem(int item, wxDirection dir, long style) const
 {

+    const int itemStart = item;
+

     int count = GetCount(),
         numCols = GetColumnCount(),
         numRows = GetRowCount();
 
     bool horz = (style & wxRA_SPECIFY_COLS) != 0;
 
     int count = GetCount(),
         numCols = GetColumnCount(),
         numRows = GetRowCount();
 
     bool horz = (style & wxRA_SPECIFY_COLS) != 0;
 

-    switch ( dir )
+    do

     {
     {

-        case wxUP:
-            if ( horz )
-            {
-                item -= numCols;
-            }
-            else // vertical layout
-            {
-                if ( !item-- )
-                    item = count - 1;
-            }
-            break;
-
-        case wxLEFT:
-            if ( horz )
-            {
-                if ( !item-- )
-                    item = count - 1;
-            }
-            else // vertical layout
-            {
-                item -= numRows;
-            }
-            break;
-
-        case wxDOWN:
-            if ( horz )
-            {
-                item += numCols;
-            }
-            else // vertical layout
-            {
-                if ( ++item == count )
-                    item = 0;
-            }
-            break;
-
-        case wxRIGHT:
-            if ( horz )
-            {
-                if ( ++item == count )
-                    item = 0;
-            }
-            else // vertical layout
-            {
-                item += numRows;
-            }
-            break;
+        switch ( dir )
+        {
+            case wxUP:
+                if ( horz )
+                {
+                    item -= numCols;
+                }
+                else // vertical layout
+                {
+                    if ( !item-- )
+                        item = count - 1;
+                }
+                break;
+
+            case wxLEFT:
+                if ( horz )
+                {
+                    if ( !item-- )
+                        item = count - 1;
+                }
+                else // vertical layout
+                {
+                    item -= numRows;
+                }
+                break;
+
+            case wxDOWN:
+                if ( horz )
+                {
+                    item += numCols;
+                }
+                else // vertical layout
+                {
+                    if ( ++item == count )
+                        item = 0;
+                }
+                break;
+
+            case wxRIGHT:
+                if ( horz )
+                {
+                    if ( ++item == count )
+                        item = 0;
+                }
+                else // vertical layout
+                {
+                    item += numRows;
+                }
+                break;
+
+            default:
+                wxFAIL_MSG( wxT("unexpected wxDirection value") );
+                return wxNOT_FOUND;
+        }

 
 

-        default:
-            wxFAIL_MSG( _T("unexpected wxDirection value") );
-            return wxNOT_FOUND;
-    }
+        // ensure that the item is in range [0..count)
+        if ( item < 0 )
+        {
+            // first map the item to the one in the same column but in the last
+            // row
+            item += count;
+
+            // now there are 2 cases: either it is the first item of the last
+            // row in which case we need to wrap again and get to the last item
+            // or we can just go to the previous item
+            if ( item % (horz ? numCols : numRows) )
+                item--;
+            else
+                item = count - 1;
+        }
+        else if ( item >= count )
+        {
+            // same logic as above
+            item -= count;
+
+            // ... except that we need to check if this is not the last item,
+            // not the first one
+            if ( (item + 1) % (horz ? numCols : numRows) )
+                item++;
+            else
+                item = 0;
+        }

 
 

-    // ensure that the item is in range [0..count)
-    if ( item < 0 )
-    {
-        // first map the item to the one in the same column but in the last row
-        item += count;
-
-        // now there are 2 cases: either it is the first item of the last row
-        // in which case we need to wrap again and get to the last item or we
-        // can just go to the previous item
-        if ( item % (horz ? numCols : numRows) )
-            item--;
-        else
-            item = count - 1;
-    }
-    else if ( item >= count )
-    {
-        // same logic as above
-        item -= count;
-
-        // ... except that we need to check if this is not the last item, not
-        // the first one
-        if ( (item + 1) % (horz ? numCols : numRows) )
-            item++;
-        else
-            item = 0;
+        wxASSERT_MSG( item < count && item >= 0,
+                      wxT("logic error in wxRadioBox::GetNextItem()") );

     }
     }

-
-    wxASSERT_MSG( item < count && item >= 0,
-                  _T("logic error in wxRadioBox::GetNextItem()") );
+    // we shouldn't select the non-active items, continue looking for a
+    // visible and shown one unless we came back to the item we started from in
+    // which case bail out to avoid infinite loop
+    while ( !(IsItemShown(item) && IsItemEnabled(item)) && item != itemStart );

 
     return item;
 }
 
     return item;
 }


@@ -158,7 +172,7 @@ int wxRadioBoxBase::GetNextItem(int item, wxDirection dir, long style) const
 
 void wxRadioBoxBase::SetItemToolTip(unsigned int item, const wxString& text)
 {
 
 void wxRadioBoxBase::SetItemToolTip(unsigned int item, const wxString& text)
 {

-    wxASSERT_MSG( item < GetCount(), _T("Invalid item index") );
+    wxASSERT_MSG( item < GetCount(), wxT("Invalid item index") );

 
     // extend the array to have entries for all our items on first use
     if ( !m_itemsTooltips )
 
     // extend the array to have entries for all our items on first use
     if ( !m_itemsTooltips )


@@ -212,8 +226,11 @@ wxRadioBoxBase::DoSetItemToolTip(unsigned int WXUNUSED(item),
     // per-item tooltips not implemented by default
 }
 
     // per-item tooltips not implemented by default
 }
 

+#endif // wxUSE_TOOLTIPS
+

 wxRadioBoxBase::~wxRadioBoxBase()
 {
 wxRadioBoxBase::~wxRadioBoxBase()
 {

+#if wxUSE_TOOLTIPS

     if ( m_itemsTooltips )
     {
         const size_t n = m_itemsTooltips->size();
     if ( m_itemsTooltips )
     {
         const size_t n = m_itemsTooltips->size();


@@ -222,22 +239,69 @@ wxRadioBoxBase::~wxRadioBoxBase()
 
         delete m_itemsTooltips;
     }
 
         delete m_itemsTooltips;
     }

+#endif // wxUSE_TOOLTIPS

 }
 
 }
 

-#endif // wxUSE_TOOLTIPS
+#if wxUSE_HELP
+
+// set helptext for a particular item
+void wxRadioBoxBase::SetItemHelpText(unsigned int n, const wxString& helpText)
+{
+    wxCHECK_RET( n < GetCount(), wxT("Invalid item index") );

 
 

-#if WXWIN_COMPATIBILITY_2_4
+    if ( m_itemsHelpTexts.empty() )
+    {
+        // once-only initialization of the array: reserve space for all items
+        m_itemsHelpTexts.Add(wxEmptyString, GetCount());
+    }
+
+    m_itemsHelpTexts[n] = helpText;
+}

 
 

-// these functions are deprecated and don't do anything
-int wxRadioBoxBase::GetNumberOfRowsOrCols() const
+// retrieve helptext for a particular item
+wxString wxRadioBoxBase::GetItemHelpText( unsigned int n ) const

 {
 {

-    return 1;
+    wxCHECK_MSG( n < GetCount(), wxEmptyString, wxT("Invalid item index") );
+
+    return m_itemsHelpTexts.empty() ? wxString() : m_itemsHelpTexts[n];

 }
 
 }
 

-void wxRadioBoxBase::SetNumberOfRowsOrCols(int WXUNUSED(n))
+// return help text for the item for which wxEVT_HELP was generated.
+wxString wxRadioBoxBase::DoGetHelpTextAtPoint(const wxWindow *derived,
+                                              const wxPoint& pt,
+                                              wxHelpEvent::Origin origin) const

 {
 {

+    int item;
+    switch ( origin )
+    {
+        case wxHelpEvent::Origin_HelpButton:
+            item = GetItemFromPoint(pt);
+            break;
+
+        case wxHelpEvent::Origin_Keyboard:
+            item = GetSelection();
+            break;
+
+        default:
+            wxFAIL_MSG( "unknown help even origin" );
+            // fall through
+
+        case wxHelpEvent::Origin_Unknown:
+            // this value is used when we're called from GetHelpText() for the
+            // radio box itself, so don't return item-specific text in this case
+            item = wxNOT_FOUND;
+    }
+
+    if ( item != wxNOT_FOUND )
+    {
+        wxString text = GetItemHelpText(static_cast<unsigned int>(item));
+        if( !text.empty() )
+            return text;
+    }
+
+    return derived->wxWindowBase::GetHelpTextAtPoint(pt, origin);

 }
 
 }
 

-#endif // WXWIN_COMPATIBILITY_2_4
+#endif // wxUSE_HELP

 
 #endif // wxUSE_RADIOBOX
 
 #endif // wxUSE_RADIOBOX