]> git.saurik.com Git - wxWidgets.git/blame - include/wx/listbox.h
another DMC build fix (http://thread.gmane.org/gmane.comp.lib.wxwidgets.devel/93155)
[wxWidgets.git] / include / wx / listbox.h
CommitLineData
2ee3ee1b
VZ
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$
77ffb593 8// Copyright: (c) wxWidgets team
65571936 9// Licence: wxWindows licence
2ee3ee1b
VZ
10///////////////////////////////////////////////////////////////////////////////
11
34138703
JS
12#ifndef _WX_LISTBOX_H_BASE_
13#define _WX_LISTBOX_H_BASE_
c801d85f 14
2ee3ee1b
VZ
15// ----------------------------------------------------------------------------
16// headers
17// ----------------------------------------------------------------------------
18
2ee3ee1b
VZ
19#include "wx/defs.h"
20
21#if wxUSE_LISTBOX
22
6c8a980f 23#include "wx/ctrlsub.h" // base class
2ee3ee1b
VZ
24
25// forward declarations are enough here
b5dbe15d
VS
26class WXDLLIMPEXP_FWD_BASE wxArrayInt;
27class WXDLLIMPEXP_FWD_BASE wxArrayString;
2ee3ee1b
VZ
28
29// ----------------------------------------------------------------------------
30// global data
31// ----------------------------------------------------------------------------
32
63ec432b 33extern WXDLLEXPORT_DATA(const wxChar) wxListBoxNameStr[];
2ee3ee1b
VZ
34
35// ----------------------------------------------------------------------------
36// wxListBox interface is defined by the class wxListBoxBase
37// ----------------------------------------------------------------------------
38
6c8a980f 39class WXDLLEXPORT wxListBoxBase : public wxControlWithItems
2ee3ee1b
VZ
40{
41public:
6463b9f5 42 wxListBoxBase() { }
799ea011 43 virtual ~wxListBoxBase();
2ee3ee1b 44
a236aa20
VZ
45 void InsertItems(unsigned int nItems, const wxString *items, unsigned int pos)
46 { Insert(nItems, items, pos); }
aa61d352 47 void InsertItems(const wxArrayString& items, unsigned int pos)
a236aa20 48 { Insert(items, pos); }
2ee3ee1b 49
6c8a980f 50 // multiple selection logic
2ee3ee1b 51 virtual bool IsSelected(int n) const = 0;
c6179a84
VZ
52 virtual void SetSelection(int n) { DoSetSelection(n, true); }
53 void SetSelection(int n, bool select) { DoSetSelection(n, select); }
54 void Deselect(int n) { DoSetSelection(n, false); }
1e6feb95 55 void DeselectAll(int itemToLeaveSelected = -1);
2ee3ee1b 56
c6179a84
VZ
57 virtual bool SetStringSelection(const wxString& s, bool select);
58 virtual bool SetStringSelection(const wxString& s)
59 {
60 return SetStringSelection(s, true);
61 }
2ee3ee1b 62
6c8a980f
VZ
63 // works for single as well as multiple selection listboxes (unlike
64 // GetSelection which only works for listboxes with single selection)
65 virtual int GetSelections(wxArrayInt& aSelections) const = 0;
2ee3ee1b 66
1e6feb95 67 // set the specified item at the first visible item or scroll to max
2ee3ee1b
VZ
68 // range.
69 void SetFirstItem(int n) { DoSetFirstItem(n); }
70 void SetFirstItem(const wxString& s);
71
1e6feb95
VZ
72 // ensures that the given item is visible scrolling the listbox if
73 // necessary
74 virtual void EnsureVisible(int n);
75
76 // a combination of Append() and EnsureVisible(): appends the item to the
77 // listbox and ensures that it is visible i.e. not scrolled out of view
78 void AppendAndEnsureVisible(const wxString& s);
79
f644b28c 80 // return true if the listbox allows multiple selection
1e6feb95
VZ
81 bool HasMultipleSelection() const
82 {
83 return (m_windowStyle & wxLB_MULTIPLE) ||
84 (m_windowStyle & wxLB_EXTENDED);
85 }
86
a236aa20
VZ
87 // override wxItemContainer::IsSorted
88 virtual bool IsSorted() const { return HasFlag( wxLB_SORT ); }
1e6feb95 89
6c8a980f
VZ
90 // emulate selecting or deselecting the item event.GetInt() (depending on
91 // event.GetExtraLong())
92 void Command(wxCommandEvent& event);
2ee3ee1b 93
8243a339
WS
94 // returns the item number at a point or wxNOT_FOUND
95 int HitTest(const wxPoint& point) const { return DoListHitTest(point); }
96
40ff126a 97#if WXWIN_COMPATIBILITY_2_6
2ee3ee1b
VZ
98 // compatibility - these functions are deprecated, use the new ones
99 // instead
40ff126a 100 wxDEPRECATED( bool Selected(int n) const );
40ff126a 101#endif // WXWIN_COMPATIBILITY_2_6
c00fed0e 102
2ee3ee1b 103protected:
2ee3ee1b 104 virtual void DoSetFirstItem(int n) = 0;
fc7a2a60 105
c6179a84
VZ
106 virtual void DoSetSelection(int n, bool select) = 0;
107
c00fed0e
VZ
108 // there is already wxWindow::DoHitTest() so call this one differently
109 virtual int DoListHitTest(const wxPoint& WXUNUSED(point)) const
110 { return wxNOT_FOUND; }
111
a236aa20 112private:
fc7a2a60 113 DECLARE_NO_COPY_CLASS(wxListBoxBase)
2ee3ee1b
VZ
114};
115
40ff126a
WS
116#if WXWIN_COMPATIBILITY_2_6
117 inline bool wxListBoxBase::Selected(int n) const { return IsSelected(n); }
40ff126a
WS
118#endif // WXWIN_COMPATIBILITY_2_6
119
2ee3ee1b
VZ
120// ----------------------------------------------------------------------------
121// include the platform-specific class declaration
122// ----------------------------------------------------------------------------
123
1e6feb95
VZ
124#if defined(__WXUNIVERSAL__)
125 #include "wx/univ/listbox.h"
126#elif defined(__WXMSW__)
2ee3ee1b 127 #include "wx/msw/listbox.h"
2049ba38 128#elif defined(__WXMOTIF__)
2ee3ee1b 129 #include "wx/motif/listbox.h"
1be7a35c 130#elif defined(__WXGTK20__)
2ee3ee1b 131 #include "wx/gtk/listbox.h"
1be7a35c
MR
132#elif defined(__WXGTK__)
133 #include "wx/gtk1/listbox.h"
34138703 134#elif defined(__WXMAC__)
2ee3ee1b 135 #include "wx/mac/listbox.h"
1777b9bb 136#elif defined(__WXPM__)
2ee3ee1b 137 #include "wx/os2/listbox.h"
e64df9bc
DE
138#elif defined(__WXCOCOA__)
139 #include "wx/cocoa/listbox.h"
c801d85f
KB
140#endif
141
2ee3ee1b
VZ
142#endif // wxUSE_LISTBOX
143
c801d85f 144#endif
34138703 145 // _WX_LISTBOX_H_BASE_