include/wx/listbox.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/listbox.h
   3 // Purpose:     wxListBox class interface
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     22.10.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWidgets team
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_LISTBOX_H_BASE_
  13 #define _WX_LISTBOX_H_BASE_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_LISTBOX
  22
  23 #include "wx/ctrlsub.h"         // base class
  24
  25 // forward declarations are enough here
  26 class WXDLLIMPEXP_BASE wxArrayInt;
  27 class WXDLLIMPEXP_BASE wxArrayString;
  28
  29 // ----------------------------------------------------------------------------
  30 // global data
  31 // ----------------------------------------------------------------------------
  32
  33 extern WXDLLEXPORT_DATA(const wxChar*) wxListBoxNameStr;
  34
  35 // ----------------------------------------------------------------------------
  36 // wxListBox interface is defined by the class wxListBoxBase
  37 // ----------------------------------------------------------------------------
  38
  39 class WXDLLEXPORT wxListBoxBase : public wxControlWithItems
  40 {
  41 public:
  42     wxListBoxBase() { }
  43     virtual ~wxListBoxBase();
  44
  45     // all generic methods are in wxControlWithItems, except for the following
  46     // ones which are not yet implemented by wxChoice/wxComboBox
  47     void Insert(const wxString& item, int pos)
  48         { DoInsert(item, pos); }
  49     void Insert(const wxString& item, int pos, void *clientData)
  50         { DoInsert(item, pos); SetClientData(pos, clientData); }
  51     void Insert(const wxString& item, int pos, wxClientData *clientData)
  52         { DoInsert(item, pos); SetClientObject(pos, clientData); }
  53
  54     void InsertItems(int nItems, const wxString *items, int pos);
  55     void InsertItems(const wxArrayString& items, int pos)
  56         { DoInsertItems(items, pos); }
  57
  58     void Set(int n, const wxString* items, void **clientData = NULL);
  59     void Set(const wxArrayString& items, void **clientData = NULL)
  60         { DoSetItems(items, clientData); }
  61
  62     // multiple selection logic
  63     virtual bool IsSelected(int n) const = 0;
  64     virtual void SetSelection(int n) { DoSetSelection(n, true); }
  65     void SetSelection(int n, bool select) { DoSetSelection(n, select); }
  66     void Deselect(int n) { DoSetSelection(n, false); }
  67     void DeselectAll(int itemToLeaveSelected = -1);
  68
  69     virtual bool SetStringSelection(const wxString& s, bool select);
  70     virtual bool SetStringSelection(const wxString& s)
  71     {
  72         return SetStringSelection(s, true);
  73     }
  74
  75     // works for single as well as multiple selection listboxes (unlike
  76     // GetSelection which only works for listboxes with single selection)
  77     virtual int GetSelections(wxArrayInt& aSelections) const = 0;
  78
  79     // set the specified item at the first visible item or scroll to max
  80     // range.
  81     void SetFirstItem(int n) { DoSetFirstItem(n); }
  82     void SetFirstItem(const wxString& s);
  83
  84     // ensures that the given item is visible scrolling the listbox if
  85     // necessary
  86     virtual void EnsureVisible(int n);
  87
  88     // a combination of Append() and EnsureVisible(): appends the item to the
  89     // listbox and ensures that it is visible i.e. not scrolled out of view
  90     void AppendAndEnsureVisible(const wxString& s);
  91
  92     // return true if the listbox allows multiple selection
  93     bool HasMultipleSelection() const
  94     {
  95         return (m_windowStyle & wxLB_MULTIPLE) ||
  96                (m_windowStyle & wxLB_EXTENDED);
  97     }
  98
  99     // return true if this listbox is sorted
 100     bool IsSorted() const { return (m_windowStyle & wxLB_SORT) != 0; }
 101
 102     // emulate selecting or deselecting the item event.GetInt() (depending on
 103     // event.GetExtraLong())
 104     void Command(wxCommandEvent& event);
 105
 106     // compatibility - these functions are deprecated, use the new ones
 107     // instead
 108     bool Selected(int n) const { return IsSelected(n); }
 109
 110 protected:
 111     // NB: due to wxGTK implementation details, DoInsert() is implemented
 112     //     using DoInsertItems() and not the other way round
 113     virtual int DoInsert(const wxString& item, int pos)
 114         { InsertItems(1, &item, pos); return pos; }
 115
 116     // to be implemented in derived classes
 117     virtual void DoInsertItems(const wxArrayString& items, int pos) = 0;
 118     virtual void DoSetItems(const wxArrayString& items, void **clientData) = 0;
 119
 120     virtual void DoSetFirstItem(int n) = 0;
 121
 122     virtual void DoSetSelection(int n, bool select) = 0;
 123
 124
 125     DECLARE_NO_COPY_CLASS(wxListBoxBase)
 126 };
 127
 128 // ----------------------------------------------------------------------------
 129 // include the platform-specific class declaration
 130 // ----------------------------------------------------------------------------
 131
 132 #if defined(__WXUNIVERSAL__)
 133     #include "wx/univ/listbox.h"
 134 #elif defined(__WXMSW__)
 135     #include "wx/msw/listbox.h"
 136 #elif defined(__WXMOTIF__)
 137     #include "wx/motif/listbox.h"
 138 #elif defined(__WXGTK__)
 139     #include "wx/gtk/listbox.h"
 140 #elif defined(__WXMAC__)
 141     #include "wx/mac/listbox.h"
 142 #elif defined(__WXPM__)
 143     #include "wx/os2/listbox.h"
 144 #elif defined(__WXCOCOA__)
 145     #include "wx/cocoa/listbox.h"
 146 #endif
 147
 148 #endif // wxUSE_LISTBOX
 149
 150 #endif
 151     // _WX_LISTBOX_H_BASE_