]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/comboctrl.tex
unified wxFRAME_EX_CONTEXTHELP and wxDIALOG_EX_CONTEXTHELP in a single wxWS_EX_CONTEX...
[wxWidgets.git] / docs / latex / wx / comboctrl.tex
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 %% Name: comboctrl.tex
3 %% Purpose: wxComboCtrl docs
4 %% Author: Jaakko Salli
5 %% Modified by:
6 %% Created:
7 %% RCS-ID: $Id$
8 %% Copyright: (c) Jaakko Salli
9 %% License: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12 \section{\class{wxComboCtrl}}\label{wxcomboctrl}
13
14 A combo control is a generic combobox that allows totally
15 custom popup. In addition it has other customization features.
16 For instance, position and size of the dropdown button
17 can be changed.
18
19 \wxheading{Setting Custom Popup for wxComboCtrl}
20
21 wxComboCtrl needs to be told somehow which control to use
22 and this is done by SetPopupControl(). However, we need
23 something more than just a wxControl in this method as,
24 for example, we need to call SetStringValue("initial text value")
25 and wxControl doesn't have such method. So we also need a
26 \helpref{wxComboPopup}{wxcombopopup} which is an interface which
27 must be implemented by a control to be usable as a popup.
28
29 We couldn't derive wxComboPopup from wxControl as this would make it
30 impossible to have a class deriving from a wxWidgets control and from
31 it, so instead it is just a mix-in.
32
33 Here's a minimal sample of \helpref{wxListView}{wxlistview} popup:
34
35 \begin{verbatim}
36
37 #include <wx/combo.h>
38 #include <wx/listctrl.h>
39
40 class wxListViewComboPopup : public wxListView,
41 public wxComboPopup
42 {
43 public:
44
45 // Initialize member variables
46 virtual void Init()
47 {
48 m_value = -1;
49 }
50
51 // Create popup control
52 virtual bool Create(wxWindow* parent)
53 {
54 return wxListView::Create(parent,1,wxPoint(0,0),wxDefaultSize);
55 }
56
57 // Return pointer to the created control
58 virtual wxWindow *GetControl() { return this; }
59
60 // Translate string into a list selection
61 virtual void SetStringValue(const wxString& s)
62 {
63 int n = wxListView::FindItem(-1,s);
64 if ( n >= 0 && n < wxListView::GetItemCount() )
65 wxListView::Select(n);
66 }
67
68 // Get list selection as a string
69 virtual wxString GetStringValue() const
70 {
71 if ( m_value >= 0 )
72 return wxListView::GetItemText(m_value);
73 return wxEmptyString;
74 }
75
76 // Do mouse hot-tracking (which is typical in list popups)
77 void OnMouseMove(wxMouseEvent& event)
78 {
79 // TODO: Move selection to cursor
80 }
81
82 // On mouse left up, set the value and close the popup
83 void OnMouseClick(wxMouseEvent& WXUNUSED(event))
84 {
85 m_value = wxListView::GetFirstSelected();
86
87 // TODO: Send event as well
88
89 Dismiss();
90 }
91
92 protected:
93
94 int m_value; // current item index
95
96 private:
97 DECLARE_EVENT_TABLE()
98 };
99
100 BEGIN_EVENT_TABLE(wxListViewComboPopup, wxListView)
101 EVT_MOTION(wxListViewComboPopup::OnMouseMove)
102 EVT_LEFT_UP(wxListViewComboPopup::OnMouseClick)
103 END_EVENT_TABLE()
104
105 \end{verbatim}
106
107 Here's how you would create and populate it in a dialog constructor:
108
109 \begin{verbatim}
110
111 wxComboCtrl* comboCtrl = new wxComboCtrl(this,wxID_ANY,wxEmptyString);
112
113 wxListViewComboPopup* popupCtrl = new wxListViewComboPopup();
114
115 comboCtrl->SetPopupControl(popupCtrl);
116
117 // Populate using wxListView methods
118 popupCtrl->InsertItem(popupCtrl->GetItemCount(),wxT("First Item"));
119 popupCtrl->InsertItem(popupCtrl->GetItemCount(),wxT("Second Item"));
120 popupCtrl->InsertItem(popupCtrl->GetItemCount(),wxT("Third Item"));
121
122 \end{verbatim}
123
124 \wxheading{Derived from}
125
126 \helpref{wxControl}{wxcontrol}\\
127 \helpref{wxWindow}{wxwindow}\\
128 \helpref{wxEvtHandler}{wxevthandler}\\
129 \helpref{wxObject}{wxobject}
130
131 \wxheading{Include files}
132
133 <combo.h>
134
135 \wxheading{Window styles}
136
137 \begin{twocollist}\itemsep=0pt
138 \twocolitem{\windowstyle{wxCB\_READONLY}}{Text will not be editable.}
139 \twocolitem{\windowstyle{wxCB\_SORT}}{Sorts the entries in the list alphabetically.}
140 \twocolitem{\windowstyle{wxTE\_PROCESS\_ENTER}}{The control will generate
141 the event wxEVT\_COMMAND\_TEXT\_ENTER (otherwise pressing Enter key
142 is either processed internally by the control or used for navigation between
143 dialog controls). Windows only.}
144 \twocolitem{\windowstyle{wxCC\_SPECIAL\_DCLICK}}{Double-clicking triggers a call
145 to popup's OnComboDoubleClick. Actual behaviour is defined by a derived
146 class. For instance, wxOwnerDrawnComboBox will cycle an item. This style only
147 applies if wxCB\_READONLY is used as well.}
148 \twocolitem{\windowstyle{wxCC\_STD\_BUTTON}}{Drop button will behave
149 more like a standard push button.}
150 \end{twocollist}
151
152 See also \helpref{window styles overview}{windowstyles}.
153
154 \wxheading{Event handling}
155
156 \twocolwidtha{7cm}
157 \begin{twocollist}\itemsep=0pt
158 \twocolitem{{\bf EVT\_TEXT(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_UPDATED event,
159 when the text changes.}
160 \twocolitem{{\bf EVT\_TEXT\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_ENTER event,
161 when <RETURN> is pressed in the combo control.}
162 \end{twocollist}
163
164 \wxheading{See also}
165
166 \helpref{wxComboBox}{wxcombobox}, \helpref{wxChoice}{wxchoice},
167 \helpref{wxOwnerDrawnComboBox}{wxownerdrawncombobox},
168 \rtfsp\helpref{wxComboPopup}{wxcombopopup}, \helpref{wxCommandEvent}{wxcommandevent}
169
170 \latexignore{\rtfignore{\wxheading{Members}}}
171
172
173 \membersection{wxComboCtrl::wxComboCtrl}\label{wxcomboctrlctor}
174
175 \func{}{wxComboCtrl}{\void}
176
177 Default constructor.
178
179 \func{}{wxComboCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
180 \param{const wxString\& }{value = ``"}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
181 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboCtrl"}}
182
183 Constructor, creating and showing a combo control.
184
185 \wxheading{Parameters}
186
187 \docparam{parent}{Parent window. Must not be NULL.}
188
189 \docparam{id}{Window identifier. A value of -1 indicates a default value.}
190
191 \docparam{value}{Initial selection string. An empty string indicates no selection.}
192
193 \docparam{pos}{Window position.}
194
195 \docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized
196 appropriately.}
197
198 \docparam{style}{Window style. See \helpref{wxComboCtrl}{wxcomboctrl}.}
199
200 \docparam{validator}{Window validator.}
201
202 \docparam{name}{Window name.}
203
204 \wxheading{See also}
205
206 \helpref{wxComboCtrl::Create}{wxcomboctrlcreate}, \helpref{wxValidator}{wxvalidator}
207
208
209 \membersection{wxComboCtrl::\destruct{wxComboCtrl}}\label{wxcomboctrldtor}
210
211 \func{}{\destruct{wxComboCtrl}}{\void}
212
213 Destructor, destroying the combo control.
214
215
216 \membersection{wxComboCtrl::Create}\label{wxcomboctrlcreate}
217
218 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
219 \param{const wxString\& }{value = ``"}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
220 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboCtrl"}}
221
222 Creates the combo control for two-step construction. Derived classes
223 should call or replace this function. See \helpref{wxComboCtrl::wxComboCtrl}{wxcomboctrlctor}\rtfsp
224 for further details.
225
226
227 \membersection{wxComboCtrl::Copy}\label{wxcomboctrlcopy}
228
229 \func{void}{Copy}{\void}
230
231 Copies the selected text to the clipboard.
232
233
234 \membersection{wxComboCtrl::Cut}\label{wxcomboctrlcut}
235
236 \func{void}{Cut}{\void}
237
238 Copies the selected text to the clipboard and removes the selection.
239
240
241 \membersection{wxComboCtrl::GetBitmapDisabled}\label{wxcomboctrlgetbitmapdisabled}
242
243 \constfunc{const wxBitmap\&}{GetBitmapDisabled}{\void}
244
245 Returns disabled button bitmap that has been set with
246 \helpref{SetButtonBitmaps}{wxcomboctrlsetbuttonbitmaps}.
247
248 \wxheading{Return value}
249
250 A reference to the disabled state bitmap.
251
252
253 \membersection{wxComboCtrl::GetBitmapHover}\label{wxcomboctrlgetbitmaphover}
254
255 \constfunc{const wxBitmap\&}{GetBitmapHover}{\void}
256
257 Returns button mouse hover bitmap that has been set with
258 \helpref{SetButtonBitmaps}{wxcomboctrlsetbuttonbitmaps}.
259
260 \wxheading{Return value}
261
262 A reference to the mouse hover state bitmap.
263
264
265 \membersection{wxComboCtrl::GetBitmapNormal}\label{wxcomboctrlgetbitmapnormal}
266
267 \constfunc{const wxBitmap\&}{GetBitmapNormal}{\void}
268
269 Returns default button bitmap that has been set with
270 \helpref{SetButtonBitmaps}{wxcomboctrlsetbuttonbitmaps}.
271
272 \wxheading{Return value}
273
274 A reference to the normal state bitmap.
275
276
277 \membersection{wxComboCtrl::GetBitmapPressed}\label{wxcomboctrlgetbitmappressed}
278
279 \constfunc{const wxBitmap\&}{GetBitmapPressed}{\void}
280
281 Returns depressed button bitmap that has been set with
282 \helpref{SetButtonBitmaps}{wxcomboctrlsetbuttonbitmaps}.
283
284 \wxheading{Return value}
285
286 A reference to the depressed state bitmap.
287
288
289 \membersection{wxComboCtrl::GetButtonSize}\label{wxcomboctrlgetbuttonsize}
290
291 \func{wxSize}{GetButtonSize}{\void}
292
293 Returns current size of the dropdown button.
294
295
296 \membersection{wxComboCtrl::GetCustomPaintWidth}\label{wxcomboctrlgetcustompaintwidth}
297
298 \constfunc{int}{GetCustomPaintWidth}{\void}
299
300 Returns custom painted area in control.
301
302 \wxheading{See also}
303
304 \helpref{wxComboCtrl::SetCustomPaintWidth}{wxcomboctrlsetcustompaintwidth}.
305
306
307 \membersection{wxComboCtrl::GetFeatures}\label{wxcomboctrlgetfeatures}
308
309 \func{static int}{GetFeatures}{\void}
310
311 Returns features supported by wxComboCtrl. If needed feature is missing,
312 you need to instead use wxGenericComboCtrl, which however may lack
313 native look and feel (but otherwise sports identical API).
314
315 \wxheading{Return value}
316
317 Value returned is a combination of following flags:
318
319 \twocolwidtha{8cm}%
320 \begin{twocollist}\itemsep=0pt
321 \twocolitem{{\tt wxComboCtrlFeatures::MovableButton}}{Button can
322 be on either side of the control.}
323 \twocolitem{{\tt wxComboCtrlFeatures::BitmapButton}}{Button may
324 be replaced with bitmap.}
325 \twocolitem{{\tt wxComboCtrlFeatures::ButtonSpacing}}{Button can
326 have spacing.}
327 \twocolitem{{\tt wxComboCtrlFeatures::TextIndent}}{SetTextIndent
328 works.}
329 \twocolitem{{\tt wxComboCtrlFeatures::PaintControl}}{Combo control
330 itself can be custom painted.}
331 \twocolitem{{\tt wxComboCtrlFeatures::PaintWritable}}{A variable-
332 width area in front of writable combo control's textctrl can
333 be custom painted.}
334 \twocolitem{{\tt wxComboCtrlFeatures::Borderless}}{wxNO\_BORDER
335 window style works.}
336 \twocolitem{{\tt wxComboCtrlFeatures::All}}{All of the
337 above.}
338 \end{twocollist}
339
340
341 \membersection{wxComboCtrl::GetInsertionPoint}\label{wxcomboctrlgetinsertionpoint}
342
343 \constfunc{long}{GetInsertionPoint}{\void}
344
345 Returns the insertion point for the combo control's text field.
346
347 \textbf{Note:} Under wxMSW, this function always returns $0$ if the combo control
348 doesn't have the focus.
349
350
351 \membersection{wxComboCtrl::GetLastPosition}\label{wxcomboctrlgetlastposition}
352
353 \constfunc{long}{GetLastPosition}{\void}
354
355 Returns the last position in the combo control text field.
356
357
358 \membersection{wxComboCtrl::GetPopupControl}\label{wxcomboctrlgetpopupcontrol}
359
360 \func{wxComboPopup*}{GetPopupControl}{\void}
361
362 Returns current popup interface that has been set with SetPopupControl.
363
364
365 \membersection{wxComboCtrl::GetPopupWindow}\label{wxcomboctrlgetpopupwindow}
366
367 \constfunc{wxWindow*}{GetPopupWindow}{\void}
368
369 Returns popup window containing the popup control.
370
371
372 \membersection{wxComboCtrl::GetTextCtrl}\label{wxcomboctrlgettextctrl}
373
374 \constfunc{wxTextCtrl*}{GetTextCtrl}{\void}
375
376 Get the text control which is part of the combo control.
377
378
379 \membersection{wxComboCtrl::GetTextIndent}\label{wxcomboctrlgettextindent}
380
381 \constfunc{wxCoord}{GetTextIndent}{\void}
382
383 Returns actual indentation in pixels.
384
385
386 \membersection{wxComboCtrl::GetValue}\label{wxcomboctrlgetvalue}
387
388 \constfunc{wxString}{GetValue}{\void}
389
390 Returns text representation of the current value. For writable
391 combo control it always returns the value in the text field.
392
393
394 \membersection{wxComboCtrl::HidePopup}\label{wxcomboctrlhidepopup}
395
396 \func{void}{HidePopup}{\void}
397
398 Dismisses the popup window.
399
400
401 \membersection{wxComboCtrl::IsPopupShown}\label{wxcomboctrlispopupshown}
402
403 \constfunc{bool}{IsPopupShown}{\void}
404
405 Returns \true if the popup is currently shown
406
407
408 \membersection{wxComboCtrl::OnButtonClick}\label{wxcomboctrlonbuttonclick}
409
410 \func{void}{OnButtonClick}{\void}
411
412 Implement in a derived class to define what happens on
413 dropdown button click.
414
415 Default action is to show the popup.
416
417
418 \membersection{wxComboCtrl::Paste}\label{wxcomboctrlpaste}
419
420 \func{void}{Paste}{\void}
421
422 Pastes text from the clipboard to the text field.
423
424
425 \membersection{wxComboCtrl::Remove}\label{wxcomboctrlremove}
426
427 \func{void}{Remove}{\param{long }{from}, \param{long }{to}}
428
429 Removes the text between the two positions in the combo control text field.
430
431 \wxheading{Parameters}
432
433 \docparam{from}{The first position.}
434
435 \docparam{to}{The last position.}
436
437
438 \membersection{wxComboCtrl::Replace}\label{wxcomboctrlreplace}
439
440 \func{void}{Replace}{\param{long }{from}, \param{long }{to}, \param{const wxString\& }{value}}
441
442 Replaces the text between two positions with the given text, in the combo control text field.
443
444 \wxheading{Parameters}
445
446 \docparam{from}{The first position.}
447
448 \docparam{to}{The second position.}
449
450 \docparam{text}{The text to insert.}
451
452
453 \membersection{wxComboCtrl::SetButtonBitmaps}\label{wxcomboctrlsetbuttonbitmaps}
454
455 \func{void}{SetButtonBitmaps}{\param{const wxBitmap\& }{bmpNormal}, \param{bool }{pushButtonBg = false}, \param{const wxBitmap\& }{bmpPressed = wxNullBitmap}, \param{const wxBitmap\& }{bmpHover = wxNullBitmap}, \param{const wxBitmap\& }{bmpDisabled = wxNullBitmap}}
456
457 Sets custom dropdown button graphics.
458
459 \wxheading{Parameters}
460
461 \docparam{bmpNormal}{Default button image.}
462 \docparam{pushButtonBg}{If \true, blank push button background is painted
463 below the image.}
464 \docparam{bmpPressed}{Depressed button image.}
465 \docparam{bmpHover}{Button image when mouse hovers above it. This
466 should be ignored on platforms and themes that do not generally draw
467 different kind of button on mouse hover.}
468 \docparam{bmpDisabled}{Disabled button image.}
469
470
471 \membersection{wxComboCtrl::SetButtonPosition}\label{wxcomboctrlsetbuttonposition}
472
473 \func{void}{SetButtonPosition}{\param{int }{width = -1}, \param{int }{height = -1}, \param{int }{side = wxRIGHT}, \param{int }{spacingX = 0}}
474
475 Sets size and position of dropdown button.
476
477 \wxheading{Parameters}
478
479 \docparam{width}{Button width. Value <= $0$ specifies default.}
480 \docparam{height}{Button height. Value <= $0$ specifies default.}
481 \docparam{side}{Indicates which side the button will be placed.
482 Value can be {\tt wxLEFT} or {\tt wxRIGHT}.}
483 \docparam{spacingX}{Horizontal spacing around the button. Default is $0$.}
484
485
486 \membersection{wxComboCtrl::SetCustomPaintWidth}\label{wxcomboctrlsetcustompaintwidth}
487
488 \func{void}{SetCustomPaintWidth}{\param{int }{width}}
489
490 Set width, in pixels, of custom painted area in control without {\tt wxCB\_READONLY}
491 style. In read-only \helpref{wxOwnerDrawnComboBox}{wxownerdrawncombobox}, this is used
492 to indicate area that is not covered by the focus rectangle.
493
494
495 \membersection{wxComboCtrl::SetInsertionPoint}\label{wxcomboctrlsetinsertionpoint}
496
497 \func{void}{SetInsertionPoint}{\param{long }{pos}}
498
499 Sets the insertion point in the text field.
500
501 \wxheading{Parameters}
502
503 \docparam{pos}{The new insertion point.}
504
505
506 \membersection{wxComboCtrl::SetInsertionPointEnd}\label{wxcomboctrlsetinsertionpointend}
507
508 \func{void}{SetInsertionPointEnd}{\void}
509
510 Sets the insertion point at the end of the combo control text field.
511
512
513 \membersection{wxComboCtrl::SetPopupAnchor}\label{wxcomboctrlsetpopupanchor}
514
515 \func{void}{SetPopupAnchor}{\param{int }{anchorSide}}
516
517 Set side of the control to which the popup will align itself. Valid values are
518 {\tt wxLEFT}, {\tt wxRIGHT} and $0$. The default value $0$ means that the most appropriate
519 side is used (which, currently, is always {\tt wxLEFT}).
520
521
522 \membersection{wxComboCtrl::SetPopupControl}\label{wxcomboctrlsetpopupcontrol}
523
524 \func{void}{SetPopupControl}{\param{wxComboPopup* }{popup}}
525
526 Set popup interface class derived from wxComboPopup.
527 This method should be called as soon as possible after the control
528 has been created, unless \helpref{OnButtonClick}{wxcomboctrlonbuttonclick}
529 has been overridden.
530
531
532 \membersection{wxComboCtrl::SetPopupExtents}\label{wxcomboctrlsetpopupextents}
533
534 \func{void}{SetPopupExtents}{\param{int }{extLeft}, \param{int }{extRight}}
535
536 Extends popup size horizontally, relative to the edges of the combo control.
537
538 \wxheading{Parameters}
539
540 \docparam{extLeft}{How many pixel to extend beyond the left edge of the
541 control. Default is $0$.}
542 \docparam{extRight}{How many pixel to extend beyond the right edge of the
543 control. Default is $0$.}
544
545 \wxheading{Remarks}
546
547 Popup minimum width may override arguments.
548
549 It is up to the popup to fully take this into account.
550
551
552 \membersection{wxComboCtrl::SetPopupMaxHeight}\label{wxcomboctrlsetpopupmaxheight}
553
554 \func{void}{SetPopupMaxHeight}{\param{int }{height}}
555
556 Sets preferred maximum height of the popup.
557
558 \wxheading{Remarks}
559
560 Value -1 indicates the default.
561
562 Also, popup implementation may choose to ignore this.
563
564
565 \membersection{wxComboCtrl::SetPopupMinWidth}\label{wxcomboctrlsetpopupminwidth}
566
567 \func{void}{SetPopupMinWidth}{\param{int }{width}}
568
569 Sets minimum width of the popup. If wider than combo control, it will extend to the left.
570
571 \wxheading{Remarks}
572
573 Value -1 indicates the default.
574
575 Also, popup implementation may choose to ignore this.
576
577
578 \membersection{wxComboCtrl::SetSelection}\label{wxcomboctrlsetselection}
579
580 \func{void}{SetSelection}{\param{long }{from}, \param{long }{to}}
581
582 Selects the text between the two positions, in the combo control text field.
583
584 \wxheading{Parameters}
585
586 \docparam{from}{The first position.}
587
588 \docparam{to}{The second position.}
589
590
591 \membersection{wxComboCtrl::SetText}\label{wxcomboctrlsettext}
592
593 \func{void}{SetText}{\param{const wxString\& }{value}}
594
595 Sets the text for the text field without affecting the
596 popup. Thus, unlike \helpref{SetValue}{wxcomboctrlsetvalue}, it works
597 equally well with combo control using {\tt wxCB\_READONLY} style.
598
599
600 \membersection{wxComboCtrl::SetTextIndent}\label{wxcomboctrlsettextindent}
601
602 \func{void}{SetTextIndent}{\param{int }{indent}}
603
604 This will set the space in pixels between left edge of the control and the
605 text, regardless whether control is read-only or not. Value -1 can be
606 given to indicate platform default.
607
608
609 \membersection{wxComboCtrl::SetValue}\label{wxcomboctrlsetvalue}
610
611 \func{void}{SetValue}{\param{const wxString\& }{value}}
612
613 Sets the text for the combo control text field.
614
615 {\bf NB:} For a combo control with {\tt wxCB\_READONLY} style the
616 string must be accepted by the popup (for instance, exist in the dropdown
617 list), otherwise the call to SetValue() is ignored
618
619
620 \membersection{wxComboCtrl::ShowPopup}\label{wxcomboctrlshowpopup}
621
622 \func{void}{ShowPopup}{\void}
623
624 Show the popup.
625
626
627 \membersection{wxComboCtrl::Undo}\label{wxcomboctrlundo}
628
629 \func{void}{Undo}{\void}
630
631 Undoes the last edit in the text field. Windows only.