X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b4e76e0d7e4c1be878e125df31dc9370bb0fa99e..1ec46a5b35233f3c69c5b73e4b0b36f44c650633:/include/wx/listbox.h?ds=sidebyside diff --git a/include/wx/listbox.h b/include/wx/listbox.h index 628ee83664..ce7fa14079 100644 --- a/include/wx/listbox.h +++ b/include/wx/listbox.h @@ -1,15 +1,128 @@ -#ifndef __LISTBOXH_BASE__ -#define __LISTBOXH_BASE__ +/////////////////////////////////////////////////////////////////////////////// +// Name: wx/listbox.h +// Purpose: wxListBox class interface +// Author: Vadim Zeitlin +// Modified by: +// Created: 22.10.99 +// RCS-ID: $Id$ +// Copyright: (c) wxWindows team +// Licence: wxWindows licence +/////////////////////////////////////////////////////////////////////////////// + +#ifndef _WX_LISTBOX_H_BASE_ +#define _WX_LISTBOX_H_BASE_ + +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- + +#ifdef __GNUG__ + #pragma interface "listboxbase.h" +#endif + +#include "wx/defs.h" + +#if wxUSE_LISTBOX + +#include "wx/ctrlsub.h" // base class + +// forward declarations are enough here +class WXDLLEXPORT wxArrayInt; +class WXDLLEXPORT wxArrayString; + +// ---------------------------------------------------------------------------- +// global data +// ---------------------------------------------------------------------------- + +WXDLLEXPORT_DATA(extern const wxChar*) wxListBoxNameStr; + +// ---------------------------------------------------------------------------- +// wxListBox interface is defined by the class wxListBoxBase +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxListBoxBase : public wxControlWithItems +{ +public: + // all generic methods are in wxControlWithItems, except for the following + // ones which are not yet implemented by wxChoice/wxCombobox +#ifdef __WXMAC_X__ + virtual ~wxListBoxBase() {} // Added min for Mac X +#endif + + 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, bool select = TRUE) = 0; + virtual void Select(int n) { SetSelection(n, TRUE); } + void Deselect(int n) { SetSelection(n, FALSE); } + + virtual bool SetStringSelection(const wxString& s, bool select = 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 + // range. + void SetFirstItem(int n) { DoSetFirstItem(n); } + void SetFirstItem(const wxString& s); + + // 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); } + + // to be implemented in derived classes + virtual void DoInsertItems(const wxArrayString& items, int pos) = 0; + virtual void DoSetItems(const wxArrayString& items, void **clientData) = 0; + + virtual void DoSetFirstItem(int n) = 0; +}; + +// ---------------------------------------------------------------------------- +// include the platform-specific class declaration +// ---------------------------------------------------------------------------- #if defined(__WXMSW__) -#include "wx/msw/listbox.h" + #include "wx/msw/listbox.h" #elif defined(__WXMOTIF__) -#include "wx/xt/listbox.h" + #include "wx/motif/listbox.h" #elif defined(__WXGTK__) -#include "wx/gtk/listbox.h" + #include "wx/gtk/listbox.h" #elif defined(__WXQT__) -#include "wx/qt/listbox.h" + #include "wx/qt/listbox.h" +#elif defined(__WXMAC__) + #include "wx/mac/listbox.h" +#elif defined(__WXPM__) + #include "wx/os2/listbox.h" +#elif defined(__WXSTUBS__) + #include "wx/stubs/listbox.h" #endif +#endif // wxUSE_LISTBOX + #endif - // __LISTBOXH_BASE__ + // _WX_LISTBOX_H_BASE_