]> git.saurik.com Git - wxWidgets.git/blame - include/wx/odcombo.h
don't use wxScopedPtr<> in wxDocTemplate::CreateDocument() as the document is implici...
[wxWidgets.git] / include / wx / odcombo.h
CommitLineData
a340b80d
VZ
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/odcombo.h
3// Purpose: wxOwnerDrawnComboBox and wxVListBoxPopup
4// Author: Jaakko Salli
5// Modified by:
6// Created: Apr-30-2006
7// RCS-ID: $Id$
8// Copyright: (c) Jaakko Salli
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_ODCOMBO_H_
13#define _WX_ODCOMBO_H_
14
15#include "wx/defs.h"
16
a57d600f 17#if wxUSE_ODCOMBOBOX
a340b80d
VZ
18
19#include "wx/combo.h"
20#include "wx/ctrlsub.h"
21#include "wx/vlbox.h"
f0fa8b47 22#include "wx/timer.h"
a340b80d
VZ
23
24
25//
26// New window styles for wxOwnerDrawnComboBox
27//
28enum
29{
30 // Double-clicking cycles item if wxCB_READONLY is also used.
31 wxODCB_DCLICK_CYCLES = wxCC_SPECIAL_DCLICK,
32
33 // If used, control itself is not custom paint using callback.
34 // Even if this is not used, writable combo is never custom paint
35 // until SetCustomPaintWidth is called
36 wxODCB_STD_CONTROL_PAINT = 0x1000
37};
38
39
40//
40b26d75 41// Callback flags (see wxOwnerDrawnComboBox::OnDrawItem)
a340b80d 42//
3fedffdc 43enum wxOwnerDrawnComboBoxPaintingFlags
a340b80d
VZ
44{
45 // when set, we are painting the selected item in control,
46 // not in the popup
ce22ac45
RR
47 wxODCB_PAINTING_CONTROL = 0x0001,
48
49
50 // when set, we are painting an item which should have
51 // focus rectangle painted in the background. Text colour
52 // and clipping region are then appropriately set in
53 // the default OnDrawBackground implementation.
54 wxODCB_PAINTING_SELECTED = 0x0002
a340b80d
VZ
55};
56
57
58// ----------------------------------------------------------------------------
59// wxVListBoxComboPopup is a wxVListBox customized to act as a popup control.
60//
61// Notes:
62// wxOwnerDrawnComboBox uses this as its popup. However, it always derives
a57d600f 63// from native wxComboCtrl. If you need to use this popup with
a340b80d
VZ
64// wxGenericComboControl, then remember that vast majority of item manipulation
65// functionality is implemented in the wxVListBoxComboPopup class itself.
66//
67// ----------------------------------------------------------------------------
68
69
c98e80d9
VZ
70class WXDLLIMPEXP_ADV wxVListBoxComboPopup : public wxVListBox,
71 public wxComboPopup
a340b80d
VZ
72{
73 friend class wxOwnerDrawnComboBox;
74public:
75
6d0ce565
VZ
76 // init and dtor
77 wxVListBoxComboPopup() : wxVListBox(), wxComboPopup() { }
a340b80d
VZ
78 virtual ~wxVListBoxComboPopup();
79
80 // required virtuals
6d0ce565 81 virtual void Init();
a340b80d
VZ
82 virtual bool Create(wxWindow* parent);
83 virtual wxWindow *GetControl() { return this; }
84 virtual void SetStringValue( const wxString& value );
85 virtual wxString GetStringValue() const;
86
87 // more customization
88 virtual void OnPopup();
89 virtual wxSize GetAdjustedSize( int minWidth, int prefHeight, int maxHeight );
90 virtual void PaintComboControl( wxDC& dc, const wxRect& rect );
91 virtual void OnComboKeyEvent( wxKeyEvent& event );
92 virtual void OnComboDoubleClick();
93 virtual bool LazyCreate();
94
95 // Item management
96 void SetSelection( int item );
97 void Insert( const wxString& item, int pos );
98 int Append(const wxString& item);
99 void Clear();
100 void Delete( unsigned int item );
101 void SetItemClientData(unsigned int n, void* clientData, wxClientDataType clientDataItemsType);
102 void *GetItemClientData(unsigned int n) const;
103 void SetString( int item, const wxString& str );
104 wxString GetString( int item ) const;
105 unsigned int GetCount() const;
9e6aca68 106 int FindString(const wxString& s, bool bCase = false) const;
6d0ce565 107 int GetSelection() const;
a340b80d 108
6d0ce565
VZ
109 //void Populate( int n, const wxString choices[] );
110 void Populate( const wxArrayString& choices );
a340b80d
VZ
111 void ClearClientDatas();
112
113 // helpers
114 int GetItemAtPosition( const wxPoint& pos ) { return HitTest(pos); }
115 wxCoord GetTotalHeight() const { return EstimateTotalHeight(); }
e02c72fa 116 wxCoord GetLineHeight(int line) const { return OnGetRowHeight(line); }
a340b80d
VZ
117
118protected:
119
120 // Called by OnComboDoubleClick and OnComboKeyEvent
dc8a1aa5 121 bool HandleKey( int keycode, bool saturate, wxChar unicode = 0 );
a340b80d
VZ
122
123 // sends combobox select event from the parent combo control
6d0ce565 124 void SendComboBoxEvent( int selection );
7ca4ac63 125
6d0ce565
VZ
126 // gets value, sends event and dismisses
127 void DismissWithEvent();
a340b80d 128
e5d63342
WS
129 // OnMeasureItemWidth will be called on next GetAdjustedSize.
130 void ItemWidthChanged(unsigned int item)
131 {
132 m_widths[item] = -1;
133 m_widthsDirty = true;
134 }
a340b80d 135
40b26d75
WS
136 // Callbacks for drawing and measuring items. Override in a derived class for
137 // owner-drawnness. Font, background and text colour have been prepared according
138 // to selection, focus and such.
139 //
140 // item: item index to be drawn, may be wxNOT_FOUND when painting combo control itself
141 // and there is no valid selection
142 // flags: wxODCB_PAINTING_CONTROL is set if painting to combo control instead of list
3fedffdc
FM
143 //
144 // NOTE: If wxVListBoxComboPopup is used with a wxComboCtrl class not derived from
40b26d75 145 // wxOwnerDrawnComboBox, this method must be overridden.
3fedffdc 146 virtual void OnDrawItem( wxDC& dc, const wxRect& rect, int item, int flags) const;
a340b80d 147
40b26d75 148 // This is same as in wxVListBox
dcc8cf5a
PC
149 virtual wxCoord OnMeasureItem( size_t item ) const;
150
40b26d75
WS
151 // Return item width, or -1 for calculating from text extent (default)
152 virtual wxCoord OnMeasureItemWidth( size_t item ) const;
153
154 // Draw item and combo control background. Flags are same as with OnDrawItem.
155 // NB: Can't use name OnDrawBackground because of virtual function hiding warnings.
156 virtual void OnDrawBg(wxDC& dc, const wxRect& rect, int item, int flags) const;
157
158 // Additional wxVListBox implementation (no need to override in derived classes)
159 virtual void OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) const;
160 void OnDrawBackground(wxDC& dc, const wxRect& rect, size_t n) const;
161
a340b80d
VZ
162 // filter mouse move events happening outside the list box
163 // move selection with cursor
164 void OnMouseMove(wxMouseEvent& event);
165 void OnMouseWheel(wxMouseEvent& event);
166 void OnKey(wxKeyEvent& event);
167 void OnLeftClick(wxMouseEvent& event);
168
d9e0958c
AB
169 // Return the widest item width (recalculating it if necessary)
170 int GetWidestItemWidth() { CalcWidths(); return m_widestWidth; }
171
172 // Return the index of the widest item (recalculating it if necessary)
173 int GetWidestItem() { CalcWidths(); return m_widestItem; }
174
dc8a1aa5
AB
175 // Stop partial completion (when some other event occurs)
176 void StopPartialCompletion();
177
a340b80d
VZ
178 wxArrayString m_strings;
179 wxArrayPtrVoid m_clientDatas;
a340b80d 180
6d0ce565 181 wxFont m_useFont;
a340b80d 182
6d0ce565 183 //wxString m_stringValue; // displayed text (may be different than m_strings[m_value])
a340b80d
VZ
184 int m_value; // selection
185 int m_itemHover; // on which item the cursor is
a340b80d
VZ
186 int m_itemHeight; // default item height (calculate from font size
187 // and used in the absence of callback)
188 wxClientDataType m_clientDataItemsType;
189
190private:
191
e5d63342
WS
192 // Cached item widths (in pixels).
193 wxArrayInt m_widths;
194
195 // Width of currently widest item.
196 int m_widestWidth;
197
198 // Index of currently widest item.
199 int m_widestItem;
200
201 // Measure some items in next GetAdjustedSize?
202 bool m_widthsDirty;
203
204 // Find widest item in next GetAdjustedSize?
205 bool m_findWidest;
206
a340b80d 207 // has the mouse been released on this control?
e5d63342 208 bool m_clicked;
a340b80d 209
d9e0958c
AB
210 // Recalculate widths if they are dirty
211 void CalcWidths();
212
dc8a1aa5
AB
213 // Partial completion string
214 wxString m_partialCompletionString;
215
fdb47e62
VZ
216 wxString m_stringValue;
217
f0fa8b47 218#if wxUSE_TIMER
dc8a1aa5
AB
219 // Partial completion timer
220 wxTimer m_partialCompletionTimer;
f0fa8b47 221#endif // wxUSE_TIMER
dc8a1aa5 222
a340b80d
VZ
223 DECLARE_EVENT_TABLE()
224};
225
226
227// ----------------------------------------------------------------------------
228// wxOwnerDrawnComboBox: a generic wxComboBox that allows custom paint items
229// in addition to many other types of customization already allowed by
a57d600f 230// the wxComboCtrl.
a340b80d
VZ
231// ----------------------------------------------------------------------------
232
a57d600f 233class WXDLLIMPEXP_ADV wxOwnerDrawnComboBox : public wxComboCtrl,
c98e80d9 234 public wxItemContainer
a340b80d 235{
40b26d75
WS
236 //friend class wxComboPopupWindow;
237 friend class wxVListBoxComboPopup;
a340b80d
VZ
238public:
239
240 // ctors and such
a57d600f 241 wxOwnerDrawnComboBox() : wxComboCtrl() { Init(); }
a340b80d
VZ
242
243 wxOwnerDrawnComboBox(wxWindow *parent,
244 wxWindowID id,
245 const wxString& value,
246 const wxPoint& pos,
247 const wxSize& size,
248 int n,
249 const wxString choices[],
250 long style = 0,
251 const wxValidator& validator = wxDefaultValidator,
252 const wxString& name = wxComboBoxNameStr)
a57d600f 253 : wxComboCtrl()
a340b80d
VZ
254 {
255 Init();
256
257 (void)Create(parent, id, value, pos, size, n,
258 choices, style, validator, name);
259 }
260
261 bool Create(wxWindow *parent,
262 wxWindowID id,
1c4743aa 263 const wxString& value = wxEmptyString,
a340b80d
VZ
264 const wxPoint& pos = wxDefaultPosition,
265 const wxSize& size = wxDefaultSize,
266 long style = 0,
267 const wxValidator& validator = wxDefaultValidator,
268 const wxString& name = wxComboBoxNameStr);
269
270 wxOwnerDrawnComboBox(wxWindow *parent,
271 wxWindowID id,
272 const wxString& value,
273 const wxPoint& pos,
274 const wxSize& size,
275 const wxArrayString& choices,
7ca4ac63 276 long style,
a340b80d
VZ
277 const wxValidator& validator = wxDefaultValidator,
278 const wxString& name = wxComboBoxNameStr);
279
280 bool Create(wxWindow *parent,
281 wxWindowID id,
1c4743aa
WS
282 const wxString& value,
283 const wxPoint& pos,
284 const wxSize& size,
285 int n,
286 const wxString choices[],
a340b80d
VZ
287 long style = 0,
288 const wxValidator& validator = wxDefaultValidator,
289 const wxString& name = wxComboBoxNameStr);
290
291 bool Create(wxWindow *parent,
292 wxWindowID id,
293 const wxString& value,
294 const wxPoint& pos,
295 const wxSize& size,
296 const wxArrayString& choices,
297 long style = 0,
298 const wxValidator& validator = wxDefaultValidator,
299 const wxString& name = wxComboBoxNameStr);
300
301 virtual ~wxOwnerDrawnComboBox();
302
db53c6ea
WS
303 // Prevent app from using wxComboPopup
304 void SetPopupControl(wxVListBoxComboPopup* popup)
305 {
306 DoSetPopupControl(popup);
307 }
6d0ce565 308
a340b80d 309 // wxControlWithItems methods
a340b80d
VZ
310 virtual unsigned int GetCount() const;
311 virtual wxString GetString(unsigned int n) const;
312 virtual void SetString(unsigned int n, const wxString& s);
9e6aca68 313 virtual int FindString(const wxString& s, bool bCase = false) const;
a340b80d
VZ
314 virtual void Select(int n);
315 virtual int GetSelection() const;
c0f48280 316 virtual void SetSelection(int n) { Select(n); }
a340b80d 317
7ca4ac63
WS
318
319 // Prevent a method from being hidden
320 virtual void SetSelection(long from, long to)
321 {
322 wxComboCtrl::SetSelection(from,to);
323 }
324
d9e0958c
AB
325 // Return the widest item width (recalculating it if necessary)
326 virtual int GetWidestItemWidth() { EnsurePopupControl(); return GetVListBoxComboPopup()->GetWidestItemWidth(); }
327
328 // Return the index of the widest item (recalculating it if necessary)
329 virtual int GetWidestItem() { EnsurePopupControl(); return GetVListBoxComboPopup()->GetWidestItem(); }
330
a236aa20
VZ
331 virtual bool IsSorted() const { return HasFlag(wxCB_SORT); }
332
a340b80d
VZ
333 wxCONTROL_ITEMCONTAINER_CLIENTDATAOBJECT_RECAST
334
335protected:
470f357f
PC
336 virtual void DoClear();
337 virtual void DoDeleteOneItem(unsigned int n);
a340b80d 338
40b26d75
WS
339 // Callback for drawing. Font, background and text colour have been
340 // prepared according to selection, focus and such.
341 // item: item index to be drawn, may be wxNOT_FOUND when painting combo control itself
342 // and there is no valid selection
343 // flags: wxODCB_PAINTING_CONTROL is set if painting to combo control instead of list
344 virtual void OnDrawItem( wxDC& dc, const wxRect& rect, int item, int flags ) const;
345
346 // Callback for item height, or -1 for default
347 virtual wxCoord OnMeasureItem( size_t item ) const;
348
349 // Callback for item width, or -1 for default/undetermined
350 virtual wxCoord OnMeasureItemWidth( size_t item ) const;
351
352 // Callback for background drawing. Flags are same as with
353 // OnDrawItem.
354 virtual void OnDrawBackground( wxDC& dc, const wxRect& rect, int item, int flags ) const;
355
db53c6ea
WS
356 // NULL popup can be used to indicate default interface
357 virtual void DoSetPopupControl(wxComboPopup* popup);
358
a340b80d
VZ
359 // clears all allocated client datas
360 void ClearClientDatas();
361
57693473
VZ
362 wxVListBoxComboPopup* GetVListBoxComboPopup() const
363 {
364 return (wxVListBoxComboPopup*) m_popupInterface;
365 }
366
a236aa20
VZ
367 virtual int DoInsertItems(const wxArrayStringsAdapter& items,
368 unsigned int pos,
369 void **clientData, wxClientDataType type);
a340b80d
VZ
370 virtual void DoSetItemClientData(unsigned int n, void* clientData);
371 virtual void* DoGetItemClientData(unsigned int n) const;
a340b80d 372
6d0ce565
VZ
373 // temporary storage for the initial choices
374 //const wxString* m_baseChoices;
375 //int m_baseChoicesCount;
376 wxArrayString m_initChs;
377
a340b80d
VZ
378private:
379 void Init();
380
381 DECLARE_EVENT_TABLE()
382
383 DECLARE_DYNAMIC_CLASS(wxOwnerDrawnComboBox)
384};
385
386
a57d600f 387#endif // wxUSE_ODCOMBOBOX
7ca4ac63 388
a340b80d
VZ
389#endif
390 // _WX_ODCOMBO_H_