X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6c8a980fc412792e64256724e02e9d387ee38e21..cba4e486a4f8ab05674bac6ed8c6bfa58ab25131:/include/wx/listbox.h diff --git a/include/wx/listbox.h b/include/wx/listbox.h index 92c7bf7c08..f023f6fa65 100644 --- a/include/wx/listbox.h +++ b/include/wx/listbox.h @@ -5,7 +5,7 @@ // Modified by: // Created: 22.10.99 // RCS-ID: $Id$ -// Copyright: (c) wxWindows team +// Copyright: (c) wxWidgets team // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// @@ -16,10 +16,6 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma interface "listboxbase.h" -#endif - #include "wx/defs.h" #if wxUSE_LISTBOX @@ -27,96 +23,141 @@ #include "wx/ctrlsub.h" // base class // forward declarations are enough here -class WXDLLEXPORT wxArrayInt; -class WXDLLEXPORT wxArrayString; +class WXDLLIMPEXP_FWD_BASE wxArrayInt; +class WXDLLIMPEXP_FWD_BASE wxArrayString; // ---------------------------------------------------------------------------- // global data // ---------------------------------------------------------------------------- -WXDLLEXPORT_DATA(extern const wxChar*) wxListBoxNameStr; +extern WXDLLIMPEXP_DATA_CORE(const char) wxListBoxNameStr[]; // ---------------------------------------------------------------------------- // wxListBox interface is defined by the class wxListBoxBase // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxListBoxBase : public wxControlWithItems +class WXDLLIMPEXP_CORE wxListBoxBase : public wxControlWithItems { public: - // all generic methods are in wxControlWithItems, except for the following - // ones which are not yet implemented by wxChoice/wxCombobox - - void Insert(const wxString& item, int pos) - { DoInsert(item, pos); } - void Insert(const wxString& item, int pos, void *clientData) - { DoInsert(item, pos); SetClientData(pos, clientData); } - void Insert(const wxString& item, int pos, wxClientData *clientData) - { DoInsert(item, pos); SetClientObject(pos, clientData); } - - void InsertItems(int nItems, const wxString *items, int pos); - void InsertItems(const wxArrayString& items, int pos) - { DoInsertItems(items, pos); } + wxListBoxBase() { } + virtual ~wxListBoxBase(); - void Set(int n, const wxString* items, void **clientData = NULL); - void Set(const wxArrayString& items, void **clientData = NULL) - { DoSetItems(items, clientData); } + void InsertItems(unsigned int nItems, const wxString *items, unsigned int pos) + { Insert(nItems, items, pos); } + void InsertItems(const wxArrayString& items, unsigned int pos) + { Insert(items, pos); } // multiple selection logic virtual bool IsSelected(int n) const = 0; - virtual void SetSelection(int n, bool select = TRUE) = 0; - virtual void Select(int n) { SetSelection(n, TRUE); } - void Deselect(int n) { SetSelection(n, FALSE); } + virtual void SetSelection(int n); + void SetSelection(int n, bool select) { DoSetSelection(n, select); } + void Deselect(int n) { DoSetSelection(n, false); } + void DeselectAll(int itemToLeaveSelected = -1); - virtual bool SetStringSelection(const wxString& s, bool select = TRUE); + virtual bool SetStringSelection(const wxString& s, bool select); + virtual bool SetStringSelection(const wxString& s) + { + return SetStringSelection(s, true); + } // works for single as well as multiple selection listboxes (unlike // GetSelection which only works for listboxes with single selection) virtual int GetSelections(wxArrayInt& aSelections) const = 0; - // Set the specified item at the first visible item or scroll to max + // set the specified item at the first visible item or scroll to max // range. void SetFirstItem(int n) { DoSetFirstItem(n); } void SetFirstItem(const wxString& s); + // ensures that the given item is visible scrolling the listbox if + // necessary + virtual void EnsureVisible(int n); + + // a combination of Append() and EnsureVisible(): appends the item to the + // listbox and ensures that it is visible i.e. not scrolled out of view + void AppendAndEnsureVisible(const wxString& s); + + // return true if the listbox allows multiple selection + bool HasMultipleSelection() const + { + return (m_windowStyle & wxLB_MULTIPLE) || + (m_windowStyle & wxLB_EXTENDED); + } + + // override wxItemContainer::IsSorted + virtual bool IsSorted() const { return HasFlag( wxLB_SORT ); } + // emulate selecting or deselecting the item event.GetInt() (depending on // event.GetExtraLong()) void Command(wxCommandEvent& event); - // compatibility - these functions are deprecated, use the new ones - // instead - bool Selected(int n) const { return IsSelected(n); } - -protected: - // NB: due to wxGTK implementation details, DoInsert() is implemented - // using DoInsertItems() and not the other way round - void DoInsert(const wxString& item, int pos) - { InsertItems(1, &item, pos); } + // return the index of the item at this position or wxNOT_FOUND + int HitTest(const wxPoint& point) const { return DoListHitTest(point); } + int HitTest(int x, int y) const { return DoListHitTest(wxPoint(x, y)); } - // to be implemented in derived classes - virtual void DoInsertItems(const wxArrayString& items, int pos) = 0; - virtual void DoSetItems(const wxArrayString& items, void **clientData) = 0; +protected: virtual void DoSetFirstItem(int n) = 0; + + virtual void DoSetSelection(int n, bool select) = 0; + + // there is already wxWindow::DoHitTest() so call this one differently + virtual int DoListHitTest(const wxPoint& WXUNUSED(point)) const + { return wxNOT_FOUND; } + + // Helper for the code generating events in single selection mode: updates + // m_oldSelections and return true if the selection really changed. + // Otherwise just returns false. + bool DoChangeSingleSelection(int item); + + // Helper for generating events in multiple and extended mode: compare the + // current selections with the previously recorded ones (in + // m_oldSelections) and send the appropriate event if they differ, + // otherwise just return false. + bool CalcAndSendEvent(); + + // Send a listbox (de)selection or double click event. + // + // Returns true if the event was processed. + bool SendEvent(wxEventType evtType, int item, bool selected); + + // Array storing the indices of all selected items that we already notified + // the user code about for multi selection list boxes. + // + // For single selection list boxes, we reuse this array to store the single + // currently selected item, this is used by DoChangeSingleSelection(). + // + // TODO-OPT: wxSelectionStore would be more efficient for big list boxes. + wxArrayInt m_oldSelections; + + // Update m_oldSelections with currently selected items (does nothing in + // single selection mode on platforms other than MSW). + void UpdateOldSelections(); + +private: + wxDECLARE_NO_COPY_CLASS(wxListBoxBase); }; // ---------------------------------------------------------------------------- // include the platform-specific class declaration // ---------------------------------------------------------------------------- -#if defined(__WXMSW__) +#if defined(__WXUNIVERSAL__) + #include "wx/univ/listbox.h" +#elif defined(__WXMSW__) #include "wx/msw/listbox.h" #elif defined(__WXMOTIF__) #include "wx/motif/listbox.h" -#elif defined(__WXGTK__) +#elif defined(__WXGTK20__) #include "wx/gtk/listbox.h" -#elif defined(__WXQT__) - #include "wx/qt/listbox.h" +#elif defined(__WXGTK__) + #include "wx/gtk1/listbox.h" #elif defined(__WXMAC__) - #include "wx/mac/listbox.h" + #include "wx/osx/listbox.h" #elif defined(__WXPM__) #include "wx/os2/listbox.h" -#elif defined(__WXSTUBS__) - #include "wx/stubs/listbox.h" +#elif defined(__WXCOCOA__) + #include "wx/cocoa/listbox.h" #endif #endif // wxUSE_LISTBOX