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_FWD_BASE wxArrayInt;
  27 class WXDLLIMPEXP_FWD_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     void InsertItems(unsigned int nItems, const wxString *items, unsigned int pos);
  46     void InsertItems(const wxArrayString& items, unsigned int pos)
  47         { DoInsertItems(items, pos); }
  48
  49     void Set(int n, const wxString* items, void **clientData = NULL);
  50     void Set(const wxArrayString& items, void **clientData = NULL)
  51         { DoSetItems(items, clientData); }
  52
  53     // multiple selection logic
  54     virtual bool IsSelected(int n) const = 0;
  55     virtual void SetSelection(int n) { DoSetSelection(n, true); }
  56     void SetSelection(int n, bool select) { DoSetSelection(n, select); }
  57     void Deselect(int n) { DoSetSelection(n, false); }
  58     void DeselectAll(int itemToLeaveSelected = -1);
  59
  60     virtual bool SetStringSelection(const wxString& s, bool select);
  61     virtual bool SetStringSelection(const wxString& s)
  62     {
  63         return SetStringSelection(s, true);
  64     }
  65
  66     // works for single as well as multiple selection listboxes (unlike
  67     // GetSelection which only works for listboxes with single selection)
  68     virtual int GetSelections(wxArrayInt& aSelections) const = 0;
  69
  70     // set the specified item at the first visible item or scroll to max
  71     // range.
  72     void SetFirstItem(int n) { DoSetFirstItem(n); }
  73     void SetFirstItem(const wxString& s);
  74
  75     // ensures that the given item is visible scrolling the listbox if
  76     // necessary
  77     virtual void EnsureVisible(int n);
  78
  79     // a combination of Append() and EnsureVisible(): appends the item to the
  80     // listbox and ensures that it is visible i.e. not scrolled out of view
  81     void AppendAndEnsureVisible(const wxString& s);
  82
  83     // return true if the listbox allows multiple selection
  84     bool HasMultipleSelection() const
  85     {
  86         return (m_windowStyle & wxLB_MULTIPLE) ||
  87                (m_windowStyle & wxLB_EXTENDED);
  88     }
  89
  90     // return true if this listbox is sorted
  91     bool IsSorted() const { return (m_windowStyle & wxLB_SORT) != 0; }
  92
  93     // emulate selecting or deselecting the item event.GetInt() (depending on
  94     // event.GetExtraLong())
  95     void Command(wxCommandEvent& event);
  96
  97     // returns the item number at a point or wxNOT_FOUND
  98     int HitTest(const wxPoint& point) const { return DoListHitTest(point); }
  99
 100 #if WXWIN_COMPATIBILITY_2_6
 101     // compatibility - these functions are deprecated, use the new ones
 102     // instead
 103     wxDEPRECATED( bool Selected(int n) const );
 104 #endif // WXWIN_COMPATIBILITY_2_6
 105
 106 protected:
 107     // NB: due to wxGTK implementation details, DoInsert() is implemented
 108     //     using DoInsertItems() and not the other way round
 109     virtual int DoInsert(const wxString& item, unsigned int pos)
 110         { InsertItems(1, &item, pos); return pos; }
 111
 112     // to be implemented in derived classes
 113     virtual void DoInsertItems(const wxArrayString& items, unsigned int pos) = 0;
 114     virtual void DoSetItems(const wxArrayString& items, void **clientData) = 0;
 115
 116     virtual void DoSetFirstItem(int n) = 0;
 117
 118     virtual void DoSetSelection(int n, bool select) = 0;
 119
 120     // there is already wxWindow::DoHitTest() so call this one differently
 121     virtual int DoListHitTest(const wxPoint& WXUNUSED(point)) const
 122         { return wxNOT_FOUND; }
 123
 124
 125     DECLARE_NO_COPY_CLASS(wxListBoxBase)
 126 };
 127
 128 #if WXWIN_COMPATIBILITY_2_6
 129     inline bool wxListBoxBase::Selected(int n) const { return IsSelected(n); }
 130 #endif // WXWIN_COMPATIBILITY_2_6
 131
 132 // ----------------------------------------------------------------------------
 133 // include the platform-specific class declaration
 134 // ----------------------------------------------------------------------------
 135
 136 #if defined(__WXUNIVERSAL__)
 137     #include "wx/univ/listbox.h"
 138 #elif defined(__WXMSW__)
 139     #include "wx/msw/listbox.h"
 140 #elif defined(__WXMOTIF__)
 141     #include "wx/motif/listbox.h"
 142 #elif defined(__WXGTK20__)
 143     #include "wx/gtk/listbox.h"
 144 #elif defined(__WXGTK__)
 145   #include "wx/gtk1/listbox.h"
 146 #elif defined(__WXMAC__)
 147     #include "wx/mac/listbox.h"
 148 #elif defined(__WXPM__)
 149     #include "wx/os2/listbox.h"
 150 #elif defined(__WXCOCOA__)
 151     #include "wx/cocoa/listbox.h"
 152 #endif
 153
 154 #endif // wxUSE_LISTBOX
 155
 156 #endif
 157     // _WX_LISTBOX_H_BASE_