X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/584ad2a32fec156c6049145d7ece9a33213aea28..90f6792f530002cf3718b0ab0ce7727be1d21729:/src/univ/listbox.cpp diff --git a/src/univ/listbox.cpp b/src/univ/listbox.cpp index d05da69d53..7c1ca6dcca 100644 --- a/src/univ/listbox.cpp +++ b/src/univ/listbox.cpp @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: univ/listbox.cpp +// Name: src/univ/listbox.cpp // Purpose: wxListBox implementation // Author: Vadim Zeitlin // Modified by: @@ -17,10 +17,6 @@ // headers // ---------------------------------------------------------------------------- -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma implementation "univlistbox.h" -#endif - #include "wx/wxprec.h" #ifdef __BORLANDC__ @@ -41,6 +37,62 @@ #include "wx/univ/inphand.h" #include "wx/univ/theme.h" +// ---------------------------------------------------------------------------- +// wxStdListboxInputHandler: handles mouse and kbd in a single or multi +// selection listbox +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxStdListboxInputHandler : public wxStdInputHandler +{ +public: + // if pressing the mouse button in a multiselection listbox should toggle + // the item under mouse immediately, then specify true as the second + // parameter (this is the standard behaviour, under GTK the item is toggled + // only when the mouse is released in the multi selection listbox) + wxStdListboxInputHandler(wxInputHandler *inphand, + bool toggleOnPressAlways = true); + + // base class methods + virtual bool HandleKey(wxInputConsumer *consumer, + const wxKeyEvent& event, + bool pressed); + virtual bool HandleMouse(wxInputConsumer *consumer, + const wxMouseEvent& event); + virtual bool HandleMouseMove(wxInputConsumer *consumer, + const wxMouseEvent& event); + +protected: + // return the item under mouse, 0 if the mouse is above the listbox or + // GetCount() if it is below it + int HitTest(const wxListBox *listbox, const wxMouseEvent& event); + + // parts of HitTest(): first finds the pseudo (because not in range) index + // of the item and the second one adjusts it if necessary - that is if the + // third one returns false + int HitTestUnsafe(const wxListBox *listbox, const wxMouseEvent& event); + int FixItemIndex(const wxListBox *listbox, int item); + bool IsValidIndex(const wxListBox *listbox, int item); + + // init m_btnCapture and m_actionMouse + wxControlAction SetupCapture(wxListBox *lbox, + const wxMouseEvent& event, + int item); + + wxRenderer *m_renderer; + + // the button which initiated the mouse capture (currently 0 or 1) + int m_btnCapture; + + // the action to perform when the mouse moves while we capture it + wxControlAction m_actionMouse; + + // the ctor parameter toggleOnPressAlways (see comments near it) + bool m_toggleOnPressAlways; + + // do we track the mouse outside the window when it is captured? + bool m_trackMouseOutside; +}; + // ============================================================================ // implementation of wxListBox // ============================================================================ @@ -68,7 +120,7 @@ void wxListBox::Init() // 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; @@ -77,7 +129,7 @@ void wxListBox::Init() m_updateScrollbarX = m_showScrollbarX = m_updateScrollbarY = - m_showScrollbarY = FALSE; + m_showScrollbarY = false; } wxListBox::wxListBox(wxWindow *parent, @@ -88,6 +140,7 @@ wxListBox::wxListBox(wxWindow *parent, long style, const wxValidator& validator, const wxString &name) + :wxScrollHelper(this) { Init(); @@ -135,24 +188,19 @@ bool wxListBox::Create(wxWindow *parent, style |= wxBORDER_SUNKEN; #endif - if ( !wxControl::Create(parent, id, pos, size, style, + if ( !wxControl::Create(parent, id, pos, size, style, validator, name) ) - return FALSE; - - SetWindow(this); + return false; - if ( style & wxLB_SORT ) - m_stringsSorted = new wxSortedArrayString; - else - m_strings = new wxArrayString; + m_strings = IsSorted() ? new wxArrayString : new wxSortedArrayString; Set(n, choices); - SetBestSize(size); + SetInitialSize(size); CreateInputHandler(wxINP_HANDLER_LISTBOX); - return TRUE; + return true; } wxListBox::~wxListBox() @@ -160,10 +208,7 @@ wxListBox::~wxListBox() // call this just to free the client data -- and avoid leaking memory DoClear(); - if ( IsSorted() ) - delete m_stringsSorted; - else - delete m_strings; + delete m_strings; m_strings = NULL; } @@ -172,57 +217,29 @@ wxListBox::~wxListBox() // adding/inserting strings // ---------------------------------------------------------------------------- -int wxListBox::DoAppend(const wxString& item) +int wxListBox::DoInsertItems(const wxArrayStringsAdapter& items, + unsigned int pos, + void **clientData, + wxClientDataType type) { - size_t index; + int idx = wxNOT_FOUND; - if ( IsSorted() ) + const unsigned int numItems = items.GetCount(); + for ( unsigned int i = 0; i < numItems; ++i ) { - index = m_stringsSorted->Add(item); - } - else - { - index = m_strings->GetCount(); - m_strings->Add(item); - } + const wxString& item = items[i]; + idx = IsSorted() ? m_strings->Add(item) + : (m_strings->Insert(item, pos), pos++); - m_itemsClientData.Insert(NULL, index); + m_itemsClientData.Insert(NULL, idx); + AssignNewItemClientData(idx, clientData, i, type); - m_updateScrollbarY = TRUE; - - if ( HasHorzScrollbar() ) - { - // has the max width increased? - wxCoord width; - GetTextExtent(item, &width, NULL); - if ( width > m_maxWidth ) - { - m_maxWidth = width; - m_maxWidthItem = index; - m_updateScrollbarX = TRUE; - } - } - - RefreshFromItemToEnd(index); - - return index; -} - -void wxListBox::DoInsertItems(const wxArrayString& items, int pos) -{ - // the position of the item being added to a sorted listbox can't be - // specified - wxCHECK_RET( !IsSorted(), _T("can't insert items into sorted listbox") ); - - size_t count = items.GetCount(); - for ( size_t n = 0; n < count; n++ ) - { - m_strings->Insert(items[n], pos + n); - m_itemsClientData.Insert(NULL, pos + n); + // call the wxCheckListBox hook + OnItemInserted(idx); } // 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 @@ -232,48 +249,22 @@ void wxListBox::DoInsertItems(const wxArrayString& items, int pos) // note that we have to refresh all the items after the ones we inserted, // not just these items RefreshFromItemToEnd(pos); + + return idx; } -void wxListBox::DoSetItems(const wxArrayString& items, void **clientData) +void wxListBox::SetString(unsigned int n, const wxString& s) { - DoClear(); - - size_t count = items.GetCount(); - if ( !count ) - return; - - m_strings->Alloc(count); - m_itemsClientData.Alloc(count); - for ( size_t n = 0; n < count; n++ ) - { - size_t index; - - if ( IsSorted() ) - { - index = m_stringsSorted->Add(items[n]); - } - else - { - index = m_strings->GetCount(); - m_strings->Add(items[n]); - } - - m_itemsClientData.Insert(clientData ? clientData[n] : NULL, index); - } + wxCHECK_RET( !IsSorted(), _T("can't set string in sorted listbox") ); - m_updateScrollbarY = TRUE; - - RefreshAll(); -} + (*m_strings)[n] = s; -void wxListBox::SetString(int n, const wxString& 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 @@ -281,18 +272,14 @@ 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 ) + else if ( n == (unsigned int)m_maxWidthItem ) { RefreshHorzScrollbar(); } } - else // no horz scrollbar - { - (*m_strings)[n] = s; - } RefreshItem(n); } @@ -305,35 +292,21 @@ void wxListBox::DoClear() { m_strings->Clear(); - if ( HasClientObjectData() ) - { - size_t count = m_itemsClientData.GetCount(); - for ( size_t n = 0; n < count; n++ ) - { - delete (wxClientData *) m_itemsClientData[n]; - } - } - m_itemsClientData.Clear(); m_selections.Clear(); m_current = -1; -} -void wxListBox::Clear() -{ - DoClear(); - - m_updateScrollbarY = TRUE; + m_updateScrollbarY = true; RefreshHorzScrollbar(); RefreshAll(); } -void wxListBox::Delete(int n) +void wxListBox::DoDeleteOneItem(unsigned int n) { - wxCHECK_RET( n >= 0 && n < GetCount(), + wxCHECK_RET( IsValid(n), _T("invalid index in wxListBox::Delete") ); // do it before removing the index as otherwise the last item will not be @@ -342,19 +315,14 @@ void wxListBox::Delete(int n) m_strings->RemoveAt(n); - if ( HasClientObjectData() ) - { - delete (wxClientData *)m_itemsClientData[n]; - } - m_itemsClientData.RemoveAt(n); // when the item disappears we must not keep using its index - if ( n == m_current ) + if ( (int)n == m_current ) { m_current = -1; } - else if ( n < m_current ) + else if ( (int)n < m_current ) { m_current--; } @@ -363,15 +331,15 @@ void wxListBox::Delete(int n) // update the selections array: the indices of all seletected items after // the one being deleted must change and the item itselfm ust be removed int index = wxNOT_FOUND; - size_t count = m_selections.GetCount(); - for ( size_t item = 0; item < count; item++ ) + unsigned int count = m_selections.GetCount(); + for ( unsigned int item = 0; item < count; item++ ) { - if ( m_selections[item] == n ) + if ( m_selections[item] == (int)n ) { // remember to delete it later index = item; } - else if ( m_selections[item] > n ) + else if ( m_selections[item] > (int)n ) { // to account for the index shift m_selections[item]--; @@ -385,10 +353,10 @@ 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 ) + if ( (int)n == m_maxWidthItem ) { RefreshHorzScrollbar(); } @@ -398,35 +366,34 @@ void wxListBox::Delete(int n) // client data handling // ---------------------------------------------------------------------------- -void wxListBox::DoSetItemClientData(int n, void* clientData) +void wxListBox::DoSetItemClientData(unsigned int n, void* clientData) { m_itemsClientData[n] = clientData; } -void *wxListBox::DoGetItemClientData(int n) const +void *wxListBox::DoGetItemClientData(unsigned int n) const { return m_itemsClientData[n]; } -void wxListBox::DoSetItemClientObject(int n, wxClientData* clientData) -{ - m_itemsClientData[n] = clientData; -} - -wxClientData* wxListBox::DoGetItemClientObject(int n) const -{ - return (wxClientData *)m_itemsClientData[n]; -} - // ---------------------------------------------------------------------------- // selection // ---------------------------------------------------------------------------- -void wxListBox::SetSelection(int n, bool select) +void wxListBox::DoSetSelection(int n, bool select) { if ( select ) { - if ( m_selections.Index(n) == wxNOT_FOUND ) + if ( n == wxNOT_FOUND ) + { + if ( !HasMultipleSelection() ) + { + // selecting wxNOT_FOUND is documented to deselect all items + DeselectAll(); + return; + } + } + else if ( m_selections.Index(n) == wxNOT_FOUND ) { if ( !HasMultipleSelection() ) { @@ -467,10 +434,10 @@ void wxListBox::SetSelection(int n, bool select) int wxListBox::GetSelection() const { - wxCHECK_MSG( !HasMultipleSelection(), -1, + wxCHECK_MSG( !HasMultipleSelection(), wxNOT_FOUND, _T("use wxListBox::GetSelections for ths listbox") ); - return m_selections.IsEmpty() ? -1 : m_selections[0]; + return m_selections.IsEmpty() ? wxNOT_FOUND : m_selections[0]; } int wxCMPFUNC_CONV wxCompareInts(int *n, int *m) @@ -482,7 +449,7 @@ int wxListBox::GetSelections(wxArrayInt& selections) const { // always return sorted array to the user selections = m_selections; - size_t count = m_selections.GetCount(); + unsigned int count = m_selections.GetCount(); // don't call sort on an empty array if ( count ) @@ -572,7 +539,7 @@ void wxListBox::RefreshAll() void wxListBox::RefreshHorzScrollbar() { m_maxWidth = 0; // recalculate it - m_updateScrollbarX = TRUE; + m_updateScrollbarX = true; } void wxListBox::UpdateScrollbars() @@ -580,9 +547,9 @@ void wxListBox::UpdateScrollbars() wxSize size = GetClientSize(); // is our height enough to show all items? - int nLines = GetCount(); + unsigned int nLines = GetCount(); wxCoord lineHeight = GetLineHeight(); - bool showScrollbarY = nLines*lineHeight > size.y; + bool showScrollbarY = (int)nLines*lineHeight > size.y; // check the width too if required wxCoord charWidth, maxWidth; @@ -596,7 +563,7 @@ void wxListBox::UpdateScrollbars() else // never show it { charWidth = maxWidth = 0; - showScrollbarX = FALSE; + showScrollbarX = false; } // what should be the scrollbar range now? @@ -656,7 +623,7 @@ void wxListBox::UpdateItems() m_updateFrom, m_updateFrom + m_updateCount - 1, rect.GetTop(), rect.GetBottom()); - Refresh(TRUE, &rect); + Refresh(true, &rect); } } @@ -667,14 +634,14 @@ void wxListBox::OnInternalIdle() UpdateScrollbars(); m_updateScrollbarX = - m_updateScrollbarY = FALSE; + m_updateScrollbarY = false; } if ( m_currentChanged ) { DoEnsureVisible(m_current); - m_currentChanged = FALSE; + m_currentChanged = false; } if ( m_updateCount ) @@ -711,9 +678,9 @@ void wxListBox::DoDraw(wxControlRenderer *renderer) // get the items which must be redrawn wxCoord lineHeight = GetLineHeight(); - size_t itemFirst = yTop / lineHeight, - itemLast = (yBottom + lineHeight - 1) / lineHeight, - itemMax = m_strings->GetCount(); + unsigned int itemFirst = yTop / lineHeight, + itemLast = (yBottom + lineHeight - 1) / lineHeight, + itemMax = m_strings->GetCount(); if ( itemFirst >= itemMax ) return; @@ -741,13 +708,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() @@ -782,10 +749,10 @@ wxCoord wxListBox::GetMaxWidth() const { wxListBox *self = wxConstCast(this, wxListBox); wxCoord width; - size_t count = m_strings->GetCount(); - for ( size_t n = 0; n < count; n++ ) + unsigned int count = m_strings->GetCount(); + for ( unsigned int 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; @@ -804,7 +771,7 @@ void wxListBox::OnSize(wxSizeEvent& event) // the scrollbars might [dis]appear m_updateScrollbarX = - m_updateScrollbarY = TRUE; + m_updateScrollbarY = true; event.Skip(); } @@ -839,11 +806,11 @@ wxSize wxListBox::DoGetBestClientSize() const wxCoord width = 0, height = 0; - size_t count = m_strings->GetCount(); - for ( size_t n = 0; n < count; n++ ) + unsigned int count = m_strings->GetCount(); + for ( unsigned int 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; @@ -893,7 +860,7 @@ bool wxListBox::SendEvent(wxEventType type, int item) event.SetString(GetString(item)); } - event.m_commandInt = item; + event.SetInt(item); return GetEventHandler()->ProcessEvent(event); } @@ -909,7 +876,7 @@ void wxListBox::SetCurrentItem(int n) if ( m_current != -1 ) { - m_currentChanged = TRUE; + m_currentChanged = true; RefreshItem(m_current); } @@ -919,11 +886,11 @@ void wxListBox::SetCurrentItem(int n) bool wxListBox::FindItem(const wxString& prefix, bool strictlyAfter) { - int count = GetCount(); - if ( !count ) + unsigned int count = GetCount(); + if ( count==0 ) { // 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 @@ -933,7 +900,7 @@ bool wxListBox::FindItem(const wxString& prefix, bool strictlyAfter) { // the following line will set first correctly to 0 if there is no // selection (m_current == -1) - first = m_current == count - 1 ? 0 : m_current + 1; + first = m_current == (int)(count - 1) ? 0 : m_current + 1; } else // start with the current { @@ -943,15 +910,15 @@ bool wxListBox::FindItem(const wxString& prefix, bool strictlyAfter) int last = first == 0 ? count - 1 : first - 1; // if this is not true we'd never exit from the loop below! - wxASSERT_MSG( first < count && last < count, _T("logic error") ); + wxASSERT_MSG( first < (int)count && last < (int)count, _T("logic error") ); // precompute it outside the loop size_t len = prefix.length(); // loop over all items in the listbox - for ( int item = first; item != last; item < count - 1 ? item++ : item = 0 ) + for ( int item = first; item != (int)last; item < (int)(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); @@ -964,12 +931,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) @@ -979,7 +946,7 @@ void wxListBox::EnsureVisible(int n) UpdateScrollbars(); m_updateScrollbarX = - m_updateScrollbarY = FALSE; + m_updateScrollbarY = false; } DoEnsureVisible(n); @@ -1061,8 +1028,8 @@ void wxListBox::ExtendSelection(int itemTo) SetSelection(n); } - int count = GetCount(); - for ( ; n < count; n++ ) + unsigned int count = GetCount(); + for ( ; n < (int)count; n++ ) { Deselect(n); } @@ -1193,7 +1160,15 @@ bool wxListBox::PerformAction(const wxControlAction& action, else return wxControl::PerformAction(action, numArg, strArg); - return TRUE; + return true; +} + +/* static */ +wxInputHandler *wxListBox::GetStdInputHandler(wxInputHandler *handlerDef) +{ + static wxStdListboxInputHandler s_handler(handlerDef); + + return &s_handler; } // ============================================================================ @@ -1207,7 +1182,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, @@ -1236,7 +1211,7 @@ int wxStdListboxInputHandler::FixItemIndex(const wxListBox *lbox, // mouse is above the first item item = 0; } - else if ( item >= lbox->GetCount() ) + else if ( (unsigned int)item >= lbox->GetCount() ) { // mouse is below the last item item = lbox->GetCount() - 1; @@ -1247,7 +1222,7 @@ int wxStdListboxInputHandler::FixItemIndex(const wxListBox *lbox, bool wxStdListboxInputHandler::IsValidIndex(const wxListBox *lbox, int item) { - return item >= 0 && item < lbox->GetCount(); + return item >= 0 && (unsigned int)item < lbox->GetCount(); } wxControlAction @@ -1315,7 +1290,7 @@ wxStdListboxInputHandler::SetupCapture(wxListBox *lbox, } // by default we always do track it - m_trackMouseOutside = TRUE; + m_trackMouseOutside = true; return action; } @@ -1327,7 +1302,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; @@ -1346,14 +1321,10 @@ bool wxStdListboxInputHandler::HandleKey(wxInputConsumer *consumer, break; case WXK_PAGEUP: - - case WXK_PRIOR: action = wxACTION_LISTBOX_PAGEUP; break; case WXK_PAGEDOWN: - - case WXK_NEXT: action = wxACTION_LISTBOX_PAGEDOWN; break; @@ -1370,24 +1341,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); @@ -1412,7 +1383,7 @@ bool wxStdListboxInputHandler::HandleKey(wxInputConsumer *consumer, //else: nothing to do for multiple selection listboxes } - return TRUE; + return true; } } @@ -1454,11 +1425,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); @@ -1478,7 +1449,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); @@ -1489,7 +1460,7 @@ bool wxStdListboxInputHandler::HandleMouseMove(wxInputConsumer *consumer, // events SetupCapture(lbox, event, item); - m_trackMouseOutside = FALSE; + m_trackMouseOutside = false; } if ( IsValidIndex(lbox, item) )