]> git.saurik.com Git - wxWidgets.git/blobdiff - src/univ/listbox.cpp
Docstring fixes
[wxWidgets.git] / src / univ / listbox.cpp
index 7ae71b51fe04672cda2ac7e7605abddda5c23165..1188a594b4d454f54636dd233897b9492e21bfed 100644 (file)
@@ -17,7 +17,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma implementation "univlistbox.h"
 #endif
 
@@ -49,8 +49,6 @@ IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControl)
 
 BEGIN_EVENT_TABLE(wxListBox, wxListBoxBase)
     EVT_SIZE(wxListBox::OnSize)
-
-    EVT_IDLE(wxListBox::OnIdle)
 END_EVENT_TABLE()
 
 // ----------------------------------------------------------------------------
@@ -65,11 +63,12 @@ void wxListBox::Init()
     m_maxWidth = 0;
     m_scrollRangeY = 0;
     m_maxWidthItem = -1;
+    m_strings = NULL;
 
     // no items hence no current item
     m_current = -1;
     m_selAnchor = -1;
-    m_currentChanged = FALSE;
+    m_currentChanged = false;
 
     // no need to update anything initially
     m_updateCount = 0;
@@ -78,7 +77,36 @@ void wxListBox::Init()
     m_updateScrollbarX =
     m_showScrollbarX =
     m_updateScrollbarY =
-    m_showScrollbarY = FALSE;
+    m_showScrollbarY = false;
+}
+
+wxListBox::wxListBox(wxWindow *parent,
+                     wxWindowID id,
+                     const wxPoint &pos,
+                     const wxSize &size,
+                     const wxArrayString& choices,
+                     long style,
+                     const wxValidator& validator,
+                     const wxString &name)
+{
+    Init();
+
+    Create(parent, id, pos, size, choices, style, validator, name);
+}
+
+bool wxListBox::Create(wxWindow *parent,
+                       wxWindowID id,
+                       const wxPoint &pos,
+                       const wxSize &size,
+                       const wxArrayString& choices,
+                       long style,
+                       const wxValidator& validator,
+                       const wxString &name)
+{
+    wxCArrayString chs(choices);
+
+    return Create(parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
+                  style, validator, name);
 }
 
 bool wxListBox::Create(wxWindow *parent,
@@ -107,14 +135,13 @@ bool wxListBox::Create(wxWindow *parent,
         style |= wxBORDER_SUNKEN;
 #endif
 
-    if ( !wxControl::Create(parent, id, pos, size, style, 
-                            wxDefaultValidator, name) )
-        return FALSE;
+    if ( !wxControl::Create(parent, id, pos, size, style,
+                            validator, name) )
+        return false;
 
     SetWindow(this);
 
-    if ( style & wxLB_SORT )
-        m_strings = wxArrayString(TRUE /* auto sort */);
+    m_strings = new wxArrayString;
 
     Set(n, choices);
 
@@ -122,25 +149,54 @@ bool wxListBox::Create(wxWindow *parent,
 
     CreateInputHandler(wxINP_HANDLER_LISTBOX);
 
-    return TRUE;
+    return true;
 }
 
 wxListBox::~wxListBox()
 {
     // call this just to free the client data -- and avoid leaking memory
     DoClear();
+
+    delete m_strings;
+
+    m_strings = NULL;
 }
 
 // ----------------------------------------------------------------------------
 // adding/inserting strings
 // ----------------------------------------------------------------------------
 
+int wxCMPFUNC_CONV wxListBoxSortNoCase(wxString* s1, wxString* s2)
+{
+    return  s1->CmpNoCase(*s2);
+}
+
+int wxListBox::DoAppendOnly(const wxString& item)
+{
+    size_t index;
+
+    if ( IsSorted() )
+    {
+        m_strings->Add(item);
+        m_strings->Sort(wxListBoxSortNoCase);
+        index = m_strings->Index(item);
+    }
+    else
+    {
+        index = m_strings->GetCount();
+        m_strings->Add(item);
+    }
+
+    return index;
+}
+
 int wxListBox::DoAppend(const wxString& item)
 {
-    size_t index = m_strings.Add(item);
+    size_t index = DoAppendOnly( item );
+
     m_itemsClientData.Insert(NULL, index);
 
-    m_updateScrollbarY = TRUE;
+    m_updateScrollbarY = true;
 
     if ( HasHorzScrollbar() )
     {
@@ -151,7 +207,7 @@ int wxListBox::DoAppend(const wxString& item)
         {
             m_maxWidth = width;
             m_maxWidthItem = index;
-            m_updateScrollbarX = TRUE;
+            m_updateScrollbarX = true;
         }
     }
 
@@ -169,12 +225,12 @@ void wxListBox::DoInsertItems(const wxArrayString& items, int pos)
     size_t count = items.GetCount();
     for ( size_t n = 0; n < count; n++ )
     {
-        m_strings.Insert(items[n], pos + n);
+        m_strings->Insert(items[n], pos + n);
         m_itemsClientData.Insert(NULL, pos + n);
     }
 
     // the number of items has changed so we might have to show the scrollbar
-    m_updateScrollbarY = TRUE;
+    m_updateScrollbarY = true;
 
     // the max width also might have changed - just recalculate it instead of
     // keeping track of it here, this is probably more efficient for a typical
@@ -194,27 +250,33 @@ void wxListBox::DoSetItems(const wxArrayString& items, void **clientData)
     if ( !count )
         return;
 
-    m_strings.Alloc(count);
+    m_strings->Alloc(count);
+
     m_itemsClientData.Alloc(count);
     for ( size_t n = 0; n < count; n++ )
     {
-        size_t index = m_strings.Add(items[n]);
+        size_t index = DoAppendOnly(items[n]);
+
         m_itemsClientData.Insert(clientData ? clientData[n] : NULL, index);
     }
 
-    m_updateScrollbarY = TRUE;
+    m_updateScrollbarY = true;
 
     RefreshAll();
 }
 
 void wxListBox::SetString(int n, const wxString& s)
 {
+    wxCHECK_RET( !IsSorted(), _T("can't set string in sorted listbox") );
+
+    (*m_strings)[n] = s;
+
     if ( HasHorzScrollbar() )
     {
         // we need to update m_maxWidth as changing the string may cause the
         // horz scrollbar [dis]appear
         wxCoord width;
-        m_strings[n] = s;
+
         GetTextExtent(s, &width, NULL);
 
         // it might have increased if the new string is long
@@ -222,7 +284,7 @@ void wxListBox::SetString(int n, const wxString& s)
         {
             m_maxWidth = width;
             m_maxWidthItem = n;
-            m_updateScrollbarX = TRUE;
+            m_updateScrollbarX = true;
         }
         // or also decreased if the old string was the longest one
         else if ( n == m_maxWidthItem )
@@ -230,10 +292,6 @@ void wxListBox::SetString(int n, const wxString& s)
             RefreshHorzScrollbar();
         }
     }
-    else // no horz scrollbar
-    {
-        m_strings[n] = s;
-    }
 
     RefreshItem(n);
 }
@@ -244,7 +302,7 @@ void wxListBox::SetString(int n, const wxString& s)
 
 void wxListBox::DoClear()
 {
-    m_strings.Clear();
+    m_strings->Clear();
 
     if ( HasClientObjectData() )
     {
@@ -265,7 +323,7 @@ void wxListBox::Clear()
 {
     DoClear();
 
-    m_updateScrollbarY = TRUE;
+    m_updateScrollbarY = true;
 
     RefreshHorzScrollbar();
 
@@ -281,7 +339,7 @@ void wxListBox::Delete(int n)
     // refreshed (as GetCount() will be decremented)
     RefreshFromItemToEnd(n);
 
-    m_strings.RemoveAt(n);
+    m_strings->RemoveAt(n);
 
     if ( HasClientObjectData() )
     {
@@ -326,7 +384,7 @@ void wxListBox::Delete(int n)
     }
 
     // the number of items has changed, hence the scrollbar may disappear
-    m_updateScrollbarY = TRUE;
+    m_updateScrollbarY = true;
 
     // finally, if the longest item was deleted the scrollbar may disappear
     if ( n == m_maxWidthItem )
@@ -513,7 +571,7 @@ void wxListBox::RefreshAll()
 void wxListBox::RefreshHorzScrollbar()
 {
     m_maxWidth = 0; // recalculate it
-    m_updateScrollbarX = TRUE;
+    m_updateScrollbarX = true;
 }
 
 void wxListBox::UpdateScrollbars()
@@ -537,7 +595,7 @@ void wxListBox::UpdateScrollbars()
     else // never show it
     {
         charWidth = maxWidth = 0;
-        showScrollbarX = FALSE;
+        showScrollbarX = false;
     }
 
     // what should be the scrollbar range now?
@@ -597,25 +655,25 @@ void wxListBox::UpdateItems()
                    m_updateFrom, m_updateFrom + m_updateCount - 1,
                    rect.GetTop(), rect.GetBottom());
 
-        Refresh(TRUE, &rect);
+        Refresh(true, &rect);
     }
 }
 
-void wxListBox::OnIdle(wxIdleEvent& event)
+void wxListBox::OnInternalIdle()
 {
     if ( m_updateScrollbarY || m_updateScrollbarX )
     {
         UpdateScrollbars();
 
         m_updateScrollbarX =
-        m_updateScrollbarY = FALSE;
+        m_updateScrollbarY = false;
     }
 
     if ( m_currentChanged )
     {
         DoEnsureVisible(m_current);
 
-        m_currentChanged = FALSE;
+        m_currentChanged = false;
     }
 
     if ( m_updateCount )
@@ -624,8 +682,7 @@ void wxListBox::OnIdle(wxIdleEvent& event)
 
         m_updateCount = 0;
     }
-
-    event.Skip();
+    wxListBoxBase::OnInternalIdle();
 }
 
 // ----------------------------------------------------------------------------
@@ -655,7 +712,7 @@ void wxListBox::DoDraw(wxControlRenderer *renderer)
     wxCoord lineHeight = GetLineHeight();
     size_t itemFirst = yTop / lineHeight,
            itemLast = (yBottom + lineHeight - 1) / lineHeight,
-           itemMax = m_strings.GetCount();
+           itemMax = m_strings->GetCount();
 
     if ( itemFirst >= itemMax )
         return;
@@ -683,13 +740,13 @@ void wxListBox::DoDrawRange(wxControlRenderer *renderer,
 bool wxListBox::SetFont(const wxFont& font)
 {
     if ( !wxControl::SetFont(font) )
-        return FALSE;
+        return false;
 
     CalcItemsPerPage();
 
     RefreshAll();
 
-    return TRUE;
+    return true;
 }
 
 void wxListBox::CalcItemsPerPage()
@@ -724,10 +781,10 @@ wxCoord wxListBox::GetMaxWidth() const
     {
         wxListBox *self = wxConstCast(this, wxListBox);
         wxCoord width;
-        size_t count = m_strings.GetCount();
+        size_t count = m_strings->GetCount();
         for ( size_t n = 0; n < count; n++ )
         {
-            GetTextExtent(m_strings[n], &width, NULL);
+            GetTextExtent(this->GetString(n), &width, NULL);
             if ( width > m_maxWidth )
             {
                 self->m_maxWidth = width;
@@ -746,7 +803,7 @@ void wxListBox::OnSize(wxSizeEvent& event)
 
     // the scrollbars might [dis]appear
     m_updateScrollbarX =
-    m_updateScrollbarY = TRUE;
+    m_updateScrollbarY = true;
 
     event.Skip();
 }
@@ -773,7 +830,7 @@ void wxListBox::DoSetSize(int x, int y,
         height = ((height - hBorders + hLine - 1) / hLine)*hLine + hBorders;
     }
 
-    wxListBoxBase::DoSetSize(x, y, width, height);
+    wxListBoxBase::DoSetSize(x, y, width, height, sizeFlags);
 }
 
 wxSize wxListBox::DoGetBestClientSize() const
@@ -781,11 +838,11 @@ wxSize wxListBox::DoGetBestClientSize() const
     wxCoord width = 0,
             height = 0;
 
-    size_t count = m_strings.GetCount();
+    size_t count = m_strings->GetCount();
     for ( size_t n = 0; n < count; n++ )
     {
         wxCoord w,h;
-        GetTextExtent(m_strings[n], &w, &h);
+        GetTextExtent(this->GetString(n), &w, &h);
 
         if ( w > width )
             width = w;
@@ -835,7 +892,7 @@ bool wxListBox::SendEvent(wxEventType type, int item)
         event.SetString(GetString(item));
     }
 
-    event.m_commandInt = item;
+    event.SetInt(item);
 
     return GetEventHandler()->ProcessEvent(event);
 }
@@ -851,7 +908,7 @@ void wxListBox::SetCurrentItem(int n)
 
         if ( m_current != -1 )
         {
-            m_currentChanged = TRUE;
+            m_currentChanged = true;
 
             RefreshItem(m_current);
         }
@@ -865,7 +922,7 @@ bool wxListBox::FindItem(const wxString& prefix, bool strictlyAfter)
     if ( !count )
     {
         // empty listbox, we can't find anything in it
-        return FALSE;
+        return false;
     }
 
     // start either from the current item or from the next one if strictlyAfter
@@ -893,7 +950,7 @@ bool wxListBox::FindItem(const wxString& prefix, bool strictlyAfter)
     // loop over all items in the listbox
     for ( int item = first; item != last; item < count - 1 ? item++ : item = 0 )
     {
-        if ( wxStrnicmp(m_strings[item], prefix, len) == 0 )
+        if ( wxStrnicmp(this->GetString(item).c_str(), prefix, len) == 0 )
         {
             SetCurrentItem(item);
 
@@ -906,12 +963,12 @@ bool wxListBox::FindItem(const wxString& prefix, bool strictlyAfter)
                     AnchorSelection(item);
             }
 
-            return TRUE;
+            return true;
         }
     }
 
     // nothing found
-    return FALSE;
+    return false;
 }
 
 void wxListBox::EnsureVisible(int n)
@@ -921,7 +978,7 @@ void wxListBox::EnsureVisible(int n)
         UpdateScrollbars();
 
         m_updateScrollbarX =
-        m_updateScrollbarY = FALSE;
+        m_updateScrollbarY = false;
     }
 
     DoEnsureVisible(n);
@@ -1135,7 +1192,7 @@ bool wxListBox::PerformAction(const wxControlAction& action,
     else
         return wxControl::PerformAction(action, numArg, strArg);
 
-    return TRUE;
+    return true;
 }
 
 // ============================================================================
@@ -1149,7 +1206,7 @@ wxStdListboxInputHandler::wxStdListboxInputHandler(wxInputHandler *handler,
     m_btnCapture = 0;
     m_toggleOnPressAlways = toggleOnPressAlways;
     m_actionMouse = wxACTION_NONE;
-    m_trackMouseOutside = TRUE;
+    m_trackMouseOutside = true;
 }
 
 int wxStdListboxInputHandler::HitTest(const wxListBox *lbox,
@@ -1257,7 +1314,7 @@ wxStdListboxInputHandler::SetupCapture(wxListBox *lbox,
     }
 
     // by default we always do track it
-    m_trackMouseOutside = TRUE;
+    m_trackMouseOutside = true;
 
     return action;
 }
@@ -1269,7 +1326,7 @@ bool wxStdListboxInputHandler::HandleKey(wxInputConsumer *consumer,
     // we're only interested in the key press events
     if ( pressed && !event.AltDown() )
     {
-        bool isMoveCmd = TRUE;
+        bool isMoveCmd = true;
         int style = consumer->GetInputWindow()->GetWindowStyle();
 
         wxControlAction action;
@@ -1312,24 +1369,24 @@ bool wxStdListboxInputHandler::HandleKey(wxInputConsumer *consumer,
                 if ( style & wxLB_MULTIPLE )
                 {
                     action = wxACTION_LISTBOX_TOGGLE;
-                    isMoveCmd = FALSE;
+                    isMoveCmd = false;
                 }
                 break;
 
             case WXK_RETURN:
                 action = wxACTION_LISTBOX_ACTIVATE;
-                isMoveCmd = FALSE;
+                isMoveCmd = false;
                 break;
 
             default:
-                if ( (keycode < 255) && wxIsalnum(keycode) )
+                if ( (keycode < 255) && wxIsalnum((wxChar)keycode) )
                 {
                     action = wxACTION_LISTBOX_FIND;
                     strArg = (wxChar)keycode;
                 }
         }
 
-        if ( !!action )
+        if ( !action.IsEmpty() )
         {
             consumer->PerformAction(action, -1, strArg);
 
@@ -1354,7 +1411,7 @@ bool wxStdListboxInputHandler::HandleKey(wxInputConsumer *consumer,
                 //else: nothing to do for multiple selection listboxes
             }
 
-            return TRUE;
+            return true;
         }
     }
 
@@ -1396,11 +1453,11 @@ bool wxStdListboxInputHandler::HandleMouse(wxInputConsumer *consumer,
         action = wxACTION_LISTBOX_ACTIVATE;
     }
 
-    if ( !!action )
+    if ( !action.IsEmpty() )
     {
         lbox->PerformAction(action, item);
 
-        return TRUE;
+        return true;
     }
 
     return wxStdInputHandler::HandleMouse(consumer, event);
@@ -1420,7 +1477,7 @@ bool wxStdListboxInputHandler::HandleMouseMove(wxInputConsumer *consumer,
             // when we do it ourselves): in this case we only react to
             // the mouse messages when they happen inside the listbox
             if ( lbox->HitTest(event.GetPosition()) != wxHT_WINDOW_INSIDE )
-                return FALSE;
+                return false;
         }
 
         int item = HitTest(lbox, event);
@@ -1431,7 +1488,7 @@ bool wxStdListboxInputHandler::HandleMouseMove(wxInputConsumer *consumer,
             // events
             SetupCapture(lbox, event, item);
 
-            m_trackMouseOutside = FALSE;
+            m_trackMouseOutside = false;
         }
 
         if ( IsValidIndex(lbox, item) )