X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2ee3ee1bc8ac2f95029835ebc115fac0a1fbd02a..6f631217a9acf6073c95f9d8ce6e3df794e5953e:/include/wx/listbox.h diff --git a/include/wx/listbox.h b/include/wx/listbox.h index 62aee761eb..d2332d5d13 100644 --- a/include/wx/listbox.h +++ b/include/wx/listbox.h @@ -5,8 +5,8 @@ // Modified by: // Created: 22.10.99 // RCS-ID: $Id$ -// Copyright: (c) wxWindows team -// Licence: wxWindows licence +// Copyright: (c) wxWidgets team +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// #ifndef _WX_LISTBOX_H_BASE_ @@ -16,163 +16,139 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma interface "listboxbase.h" -#endif - #include "wx/defs.h" #if wxUSE_LISTBOX -#include "wx/control.h" // base class +#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 wxControl +class WXDLLIMPEXP_CORE wxListBoxBase : public wxControlWithItems { public: - // ctor - wxListBoxBase() { m_clientDataItemsType = ClientData_None; } - - // adding items - // ------------ + wxListBoxBase() { } + virtual ~wxListBoxBase(); - void Append(const wxString& item) - { DoAppend(item); } - void Append(const wxString& item, void *clientData) - { int n = DoAppend(item); SetClientData(n, clientData); } - void Append(const wxString& item, wxClientData *clientData) - { int n = DoAppend(item); SetClientObject(n, 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); } - 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); } - - void Set(int n, const wxString* items, void **clientData = NULL); - void Set(const wxArrayString& items, void **clientData = NULL) - { DoSetItems(items, clientData); } + // multiple selection logic + virtual bool IsSelected(int n) const = 0; + virtual void SetSelection(int n) { DoSetSelection(n, true); } + 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); + 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; - // deleting items - // -------------- + // 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); - virtual void Clear() = 0; - virtual void Delete(int n) = 0; + // ensures that the given item is visible scrolling the listbox if + // necessary + virtual void EnsureVisible(int n); - // accessing strings - // ----------------- + // 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); - virtual int GetCount() const = 0; - virtual wxString GetString(int n) const = 0; - virtual void SetString(int n, const wxString& s) = 0; - virtual int FindString(const wxString& s) const = 0; + // return true if the listbox allows multiple selection + bool HasMultipleSelection() const + { + return (m_windowStyle & wxLB_MULTIPLE) || + (m_windowStyle & wxLB_EXTENDED); + } - // selection - // --------- + // override wxItemContainer::IsSorted + virtual bool IsSorted() const { return HasFlag( wxLB_SORT ); } - virtual bool IsSelected(int n) const = 0; - virtual void SetSelection(int n, bool select = TRUE) = 0; - void Select(int n) { SetSelection(n, TRUE); } - void Deselect(int n) { SetSelection(n, FALSE); } + // emulate selecting or deselecting the item event.GetInt() (depending on + // event.GetExtraLong()) + void Command(wxCommandEvent& event); - virtual int GetSelection() const = 0; - virtual int GetSelections(wxArrayInt& aSelections) const = 0; + // 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)); } - bool SetStringSelection(const wxString& s, bool select = TRUE); - wxString GetStringSelection() const; - // misc - // ---- + // 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(); - // client data stuff - void SetClientData( int n, void* clientData ); - void* GetClientData( int n ) const; - - void SetClientObject( int n, wxClientData* clientData ); - wxClientData* GetClientObject( int n ) const; - - // 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); +protected: + virtual void DoSetFirstItem(int n) = 0; - // emulate selecting or deselecting (depending on event.GetExtraLong()) - // the item event.GetInt() from the control - virtual void Command(wxCommandEvent &event); + virtual void DoSetSelection(int n, bool select) = 0; - // compatibility - these functions are deprecated, use the new ones - // instead - bool Selected(int n) const { return IsSelected(n); } - int Number() const { return GetCount(); } + // there is already wxWindow::DoHitTest() so call this one differently + virtual int DoListHitTest(const wxPoint& WXUNUSED(point)) const + { return wxNOT_FOUND; } -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); } + // Send a listbox (de)selection or double click event. + // + // Returns true if the event was processed. + bool SendEvent(wxEventType evtType, int item, bool selected); - // to be implemented in derived classes - virtual int DoAppend(const wxString& item) = 0; - virtual void DoInsertItems(const wxArrayString& items, int pos) = 0; - virtual void DoSetItems(const wxArrayString& items, void **clientData) = 0; + // Array storing the indices of all selected items that we already notified + // the user code about for multi selection list boxes. + // + // TODO-OPT: wxSelectionStore would be more efficient for big list boxes. + wxArrayInt m_oldSelections; - virtual void DoSetFirstItem(int n) = 0; + // Update m_oldSelections with currently selected items (does nothing in + // single selection mode on platforms other than MSW). + void UpdateOldSelections(); - virtual void DoSetClientData(int n, void* clientData) = 0; - virtual void* DoGetClientData(int n) const = 0; - virtual void DoSetClientObject(int n, wxClientData* clientData) = 0; - virtual wxClientData* DoGetClientObject(int n) const = 0; - - // the above pure virtuals hide these virtuals in wxWindowBase - virtual void DoSetClientData(void* clientData ) - { wxWindowBase::DoSetClientData(clientData); }; - virtual void* DoGetClientData() const - { return(wxWindowBase::DoGetClientData()); }; - virtual void DoSetClientObject( wxClientData* clientData ) - { wxWindowBase::DoSetClientObject(clientData); }; - virtual wxClientData* DoGetClientObject() const - { return(wxWindowBase::DoGetClientObject()); }; - - // the type of the client data for the items - wxClientDataType m_clientDataItemsType; +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