]> git.saurik.com Git - wxWidgets.git/blob - include/wx/msw/listbox.h
Fix wrong return value in the changes of r73365.
[wxWidgets.git] / include / wx / msw / listbox.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/msw/listbox.h
3 // Purpose: wxListBox class
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_LISTBOX_H_
13 #define _WX_LISTBOX_H_
14
15 #if wxUSE_LISTBOX
16
17 // ----------------------------------------------------------------------------
18 // simple types
19 // ----------------------------------------------------------------------------
20
21 #if wxUSE_OWNER_DRAWN
22 class WXDLLIMPEXP_FWD_CORE wxOwnerDrawn;
23
24 // define the array of list box items
25 #include "wx/dynarray.h"
26
27 WX_DEFINE_EXPORTED_ARRAY_PTR(wxOwnerDrawn *, wxListBoxItemsArray);
28 #endif // wxUSE_OWNER_DRAWN
29
30 // forward decl for GetSelections()
31 class WXDLLIMPEXP_FWD_BASE wxArrayInt;
32
33 // ----------------------------------------------------------------------------
34 // List box control
35 // ----------------------------------------------------------------------------
36
37 class WXDLLIMPEXP_CORE wxListBox : public wxListBoxBase
38 {
39 public:
40 // ctors and such
41 wxListBox() { Init(); }
42 wxListBox(wxWindow *parent, wxWindowID id,
43 const wxPoint& pos = wxDefaultPosition,
44 const wxSize& size = wxDefaultSize,
45 int n = 0, const wxString choices[] = NULL,
46 long style = 0,
47 const wxValidator& validator = wxDefaultValidator,
48 const wxString& name = wxListBoxNameStr)
49 {
50 Init();
51
52 Create(parent, id, pos, size, n, choices, style, validator, name);
53 }
54 wxListBox(wxWindow *parent, wxWindowID id,
55 const wxPoint& pos,
56 const wxSize& size,
57 const wxArrayString& choices,
58 long style = 0,
59 const wxValidator& validator = wxDefaultValidator,
60 const wxString& name = wxListBoxNameStr)
61 {
62 Init();
63
64 Create(parent, id, pos, size, choices, style, validator, name);
65 }
66
67 bool Create(wxWindow *parent, wxWindowID id,
68 const wxPoint& pos = wxDefaultPosition,
69 const wxSize& size = wxDefaultSize,
70 int n = 0, const wxString choices[] = NULL,
71 long style = 0,
72 const wxValidator& validator = wxDefaultValidator,
73 const wxString& name = wxListBoxNameStr);
74 bool Create(wxWindow *parent, wxWindowID id,
75 const wxPoint& pos,
76 const wxSize& size,
77 const wxArrayString& choices,
78 long style = 0,
79 const wxValidator& validator = wxDefaultValidator,
80 const wxString& name = wxListBoxNameStr);
81
82 virtual ~wxListBox();
83
84 virtual unsigned int GetCount() const;
85 virtual wxString GetString(unsigned int n) const;
86 virtual void SetString(unsigned int n, const wxString& s);
87 virtual int FindString(const wxString& s, bool bCase = false) const;
88
89 virtual bool IsSelected(int n) const;
90 virtual int GetSelection() const;
91 virtual int GetSelections(wxArrayInt& aSelections) const;
92
93 // return the index of the item at this position or wxNOT_FOUND
94 int HitTest(const wxPoint& pt) const { return DoHitTestList(pt); }
95 int HitTest(wxCoord x, wxCoord y) const { return DoHitTestList(wxPoint(x, y)); }
96
97 // ownerdrawn wxListBox and wxCheckListBox support
98 #if wxUSE_OWNER_DRAWN
99 // override base class virtuals
100 virtual bool SetFont(const wxFont &font);
101
102 bool MSWOnMeasure(WXMEASUREITEMSTRUCT *item);
103 bool MSWOnDraw(WXDRAWITEMSTRUCT *item);
104
105 // plug-in for derived classes
106 virtual wxOwnerDrawn *CreateLboxItem(size_t n);
107
108 // allows to get the item and use SetXXX functions to set it's appearance
109 wxOwnerDrawn *GetItem(size_t n) const { return m_aItems[n]; }
110
111 // get the index of the given item
112 int GetItemIndex(wxOwnerDrawn *item) const { return m_aItems.Index(item); }
113
114 // get rect of the given item index
115 bool GetItemRect(size_t n, wxRect& rect) const;
116
117 // redraw the given item
118 bool RefreshItem(size_t n);
119 #endif // wxUSE_OWNER_DRAWN
120
121 // Windows-specific code to update the horizontal extent of the listbox, if
122 // necessary. If s is non-empty, the horizontal extent is increased to the
123 // length of this string if it's currently too short, otherwise the maximum
124 // extent of all strings is used. In any case calls InvalidateBestSize()
125 virtual void SetHorizontalExtent(const wxString& s = wxEmptyString);
126
127 // Windows callbacks
128 bool MSWCommand(WXUINT param, WXWORD id);
129 WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
130
131 // under XP when using "transition effect for menus and tooltips" if we
132 // return true for WM_PRINTCLIENT here then it causes noticable slowdown
133 virtual bool MSWShouldPropagatePrintChild()
134 {
135 return false;
136 }
137
138 virtual wxVisualAttributes GetDefaultAttributes() const
139 {
140 return GetClassDefaultAttributes(GetWindowVariant());
141 }
142
143 static wxVisualAttributes
144 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL)
145 {
146 return GetCompositeControlsDefaultAttributes(variant);
147 }
148
149 // returns true if the platform should explicitly apply a theme border
150 virtual bool CanApplyThemeBorder() const { return false; }
151
152 virtual void OnInternalIdle();
153
154 protected:
155 virtual wxSize DoGetBestClientSize() const;
156
157 virtual void DoClear();
158 virtual void DoDeleteOneItem(unsigned int n);
159
160 virtual void DoSetSelection(int n, bool select);
161
162 virtual int DoInsertItems(const wxArrayStringsAdapter& items,
163 unsigned int pos,
164 void **clientData, wxClientDataType type);
165
166 virtual void DoSetFirstItem(int n);
167 virtual void DoSetItemClientData(unsigned int n, void* clientData);
168 virtual void* DoGetItemClientData(unsigned int n) const;
169
170 // this can't be called DoHitTest() because wxWindow already has this method
171 virtual int DoHitTestList(const wxPoint& point) const;
172
173 // free memory (common part of Clear() and dtor)
174 void Free();
175
176 unsigned int m_noItems;
177
178 #if wxUSE_OWNER_DRAWN
179 // control items
180 wxListBoxItemsArray m_aItems;
181 #endif
182
183 private:
184 // common part of all ctors
185 void Init();
186
187 // call this when items are added to or deleted from the listbox or an
188 // items text changes
189 void MSWOnItemsChanged();
190
191 // flag indicating whether the max horizontal extent should be updated,
192 // i.e. if we need to call SetHorizontalExtent() from OnInternalIdle()
193 bool m_updateHorizontalExtent;
194
195
196 DECLARE_DYNAMIC_CLASS_NO_COPY(wxListBox)
197 };
198
199 #endif // wxUSE_LISTBOX
200
201 #endif
202 // _WX_LISTBOX_H_