1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
/////////////////////////////////////////////////////////////////////////////
// Name: odcombo.h
// Purpose: interface of wxOwnerDrawnComboBox
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
enum wxOwnerDrawnComboBoxPaintingFlags
{
/**
Combo control is being painted, instead of a list item.
Argument item may be @c wxNOT_FOUND in this case.
*/
wxODCB_PAINTING_CONTROL = 0x0001,
/**
An item with selection background is being painted.
DC text colour should already be correct.
*/
wxODCB_PAINTING_SELECTED = 0x0002
};
/**
New window styles for wxOwnerDrawnComboBox
*/
enum
{
/**
Double-clicking cycles item if wxCB_READONLY is also used.
*/
wxODCB_DCLICK_CYCLES = wxCC_SPECIAL_DCLICK,
/**
If used, control itself is not custom paint using callback.
Even if this is not used, writable combo is never custom paint
until SetCustomPaintWidth is called
*/
wxODCB_STD_CONTROL_PAINT = 0x1000
};
/**
@class wxOwnerDrawnComboBox
wxOwnerDrawnComboBox is a combobox with owner-drawn list items.
In essence, it is a wxComboCtrl with wxVListBox popup and wxControlWithItems
interface.
Implementing item drawing and measuring is similar to wxVListBox.
Application needs to subclass wxOwnerDrawnComboBox and implement
OnDrawItem(), OnMeasureItem() and OnMeasureItemWidth().
@beginStyleTable
@style{wxODCB_DCLICK_CYCLES}
Double-clicking cycles item if wxCB_READONLY is also used.
Synonymous with wxCC_SPECIAL_DCLICK.
@style{wxODCB_STD_CONTROL_PAINT}
Control itself is not custom painted using OnDrawItem. Even if this
style is not used, writable wxOwnerDrawnComboBox is never custom
painted unless SetCustomPaintWidth() is called.
@endStyleTable
@see wxComboCtrl window styles and @ref overview_windowstyles.
@beginEventEmissionTable{wxCommandEvent}
@event{EVT_COMBOBOX(id, func)}
Process a wxEVT_COMBOBOX event, when an item on
the list is selected. Note that calling GetValue() returns the new
value of selection.
@endEventTable
@see Events emitted by wxComboCtrl.
@library{wxadv}
@category{ctrl}
@appearance{ownerdrawncombobox}
@see wxComboCtrl, wxComboBox, wxVListBox, wxCommandEvent
*/
class wxOwnerDrawnComboBox : public wxComboCtrl, public wxItemContainer
{
public:
/**
Default constructor.
*/
wxOwnerDrawnComboBox();
/**
Constructor, creating and showing a owner-drawn combobox.
@param parent
Parent window. Must not be @NULL.
@param id
Window identifier. The value @c wxID_ANY indicates a default value.
@param value
Initial selection string. An empty string indicates no selection.
@param pos
Window position.
@param size
Window size.
If ::wxDefaultSize is specified then the window is sized appropriately.
@param n
Number of strings with which to initialise the control.
@param choices
An array of strings with which to initialise the control.
@param style
Window style. See wxOwnerDrawnComboBox.
@param validator
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxOwnerDrawnComboBox(wxWindow* parent, wxWindowID id,
const wxString& value = wxEmptyString,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
int n = 0,
const wxString choices[] = NULL,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "comboBox");
/**
Constructor, creating and showing a owner-drawn combobox.
@param parent
Parent window. Must not be @NULL.
@param id
Window identifier. The value @c wxID_ANY indicates a default value.
@param value
Initial selection string. An empty string indicates no selection.
@param pos
Window position.
@param size
Window size.
If ::wxDefaultSize is specified then the window is sized appropriately.
@param choices
An array of strings with which to initialise the control.
@param style
Window style. See wxOwnerDrawnComboBox.
@param validator
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxOwnerDrawnComboBox(wxWindow* parent, wxWindowID id,
const wxString& value,
const wxPoint& pos,
const wxSize& size,
const wxArrayString& choices,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "comboBox");
/**
Destructor, destroying the owner-drawn combobox.
*/
virtual ~wxOwnerDrawnComboBox();
//@{
/**
Creates the combobox for two-step construction.
See wxOwnerDrawnComboBox() for further details.
@remarks Derived classes should call or replace this function.
*/
bool Create(wxWindow *parent,
wxWindowID id,
const wxString& value = wxEmptyString,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxComboBoxNameStr);
bool Create(wxWindow *parent,
wxWindowID id,
const wxString& value,
const wxPoint& pos,
const wxSize& size,
int n,
const wxString choices[],
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxComboBoxNameStr);
bool Create(wxWindow *parent,
wxWindowID id,
const wxString& value,
const wxPoint& pos,
const wxSize& size,
const wxArrayString& choices,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxComboBoxNameStr);
//@}
/**
Returns index to the widest item in the list.
*/
virtual int GetWidestItem();
/**
Returns width of the widest item in the list.
*/
virtual int GetWidestItemWidth();
protected:
/**
This method is used to draw the items background and, maybe, a border around it.
The base class version implements a reasonable default behaviour which consists
in drawing the selected item with the standard background colour and drawing a
border around the item if it is either selected or current.
@remarks flags has the same meaning as with OnDrawItem().
*/
virtual void OnDrawBackground(wxDC& dc, const wxRect& rect, int item,
int flags) const;
/**
The derived class may implement this function to actually draw the item
with the given index on the provided DC.
If function is not implemented, the item text is simply drawn, as if the control
was a normal combobox.
@param dc
The device context to use for drawing
@param rect
The bounding rectangle for the item being drawn (DC clipping
region is set to this rectangle before calling this function)
@param item
The index of the item to be drawn
@param flags
A combination of the ::wxOwnerDrawnComboBoxPaintingFlags enumeration values.
*/
virtual void OnDrawItem(wxDC& dc, const wxRect& rect, int item,
int flags) const;
/**
The derived class may implement this method to return the height of the
specified item (in pixels).
The default implementation returns text height, as if this control was
a normal combobox.
*/
virtual wxCoord OnMeasureItem(size_t item) const;
/**
The derived class may implement this method to return the width of the
specified item (in pixels). If -1 is returned, then the item text width
is used.
The default implementation returns -1.
*/
virtual wxCoord OnMeasureItemWidth(size_t item) const;
};
|
