]>
Commit | Line | Data |
---|---|---|
1154f91b BW |
1 | /////////////////////////////////////////////////////////////////////////////// |
2 | // Name: wx/aui/toolbar.h | |
3 | // Purpose: wxaui: wx advanced user interface - docking window manager | |
4 | // Author: Benjamin I. Williams | |
5 | // Modified by: | |
6 | // Created: 2008-08-04 | |
1154f91b BW |
7 | // Copyright: (C) Copyright 2005, Kirix Corporation, All Rights Reserved. |
8 | // Licence: wxWindows Library Licence, Version 3.1 | |
9 | /////////////////////////////////////////////////////////////////////////////// | |
10 | ||
1154f91b BW |
11 | #ifndef _WX_AUIBAR_H_ |
12 | #define _WX_AUIBAR_H_ | |
13 | ||
1154f91b BW |
14 | #include "wx/defs.h" |
15 | ||
16 | #if wxUSE_AUI | |
17 | ||
9da38912 | 18 | #include "wx/control.h" |
8e190381 FM |
19 | #include "wx/sizer.h" |
20 | #include "wx/pen.h" | |
21 | ||
f3cf14a9 VZ |
22 | class WXDLLIMPEXP_FWD_CORE wxClientDC; |
23 | class WXDLLIMPEXP_FWD_AUI wxAuiPaneInfo; | |
1154f91b BW |
24 | |
25 | enum wxAuiToolBarStyle | |
26 | { | |
27 | wxAUI_TB_TEXT = 1 << 0, | |
28 | wxAUI_TB_NO_TOOLTIPS = 1 << 1, | |
29 | wxAUI_TB_NO_AUTORESIZE = 1 << 2, | |
30 | wxAUI_TB_GRIPPER = 1 << 3, | |
31 | wxAUI_TB_OVERFLOW = 1 << 4, | |
e5dcae09 VZ |
32 | // using this style forces the toolbar to be vertical and |
33 | // be only dockable to the left or right sides of the window | |
34 | // whereas by default it can be horizontal or vertical and | |
35 | // be docked anywhere | |
1154f91b | 36 | wxAUI_TB_VERTICAL = 1 << 5, |
9578058d | 37 | wxAUI_TB_HORZ_LAYOUT = 1 << 6, |
e5dcae09 VZ |
38 | // analogous to wxAUI_TB_VERTICAL, but forces the toolbar |
39 | // to be horizontal | |
40 | wxAUI_TB_HORIZONTAL = 1 << 7, | |
526502d1 | 41 | wxAUI_TB_PLAIN_BACKGROUND = 1 << 8, |
9578058d | 42 | wxAUI_TB_HORZ_TEXT = (wxAUI_TB_HORZ_LAYOUT | wxAUI_TB_TEXT), |
e5dcae09 | 43 | wxAUI_ORIENTATION_MASK = (wxAUI_TB_VERTICAL | wxAUI_TB_HORIZONTAL), |
1154f91b BW |
44 | wxAUI_TB_DEFAULT_STYLE = 0 |
45 | }; | |
46 | ||
47 | enum wxAuiToolBarArtSetting | |
48 | { | |
49 | wxAUI_TBART_SEPARATOR_SIZE = 0, | |
50 | wxAUI_TBART_GRIPPER_SIZE = 1, | |
51 | wxAUI_TBART_OVERFLOW_SIZE = 2 | |
52 | }; | |
53 | ||
54 | enum wxAuiToolBarToolTextOrientation | |
55 | { | |
56 | wxAUI_TBTOOL_TEXT_LEFT = 0, // unused/unimplemented | |
57 | wxAUI_TBTOOL_TEXT_RIGHT = 1, | |
58 | wxAUI_TBTOOL_TEXT_TOP = 2, // unused/unimplemented | |
59 | wxAUI_TBTOOL_TEXT_BOTTOM = 3 | |
60 | }; | |
61 | ||
62 | ||
63 | // aui toolbar event class | |
64 | ||
65 | class WXDLLIMPEXP_AUI wxAuiToolBarEvent : public wxNotifyEvent | |
66 | { | |
67 | public: | |
9a29fe70 VZ |
68 | wxAuiToolBarEvent(wxEventType commandType = wxEVT_NULL, |
69 | int winId = 0) | |
70 | : wxNotifyEvent(commandType, winId) | |
1154f91b | 71 | { |
9a29fe70 VZ |
72 | m_isDropdownClicked = false; |
73 | m_clickPt = wxPoint(-1, -1); | |
74 | m_rect = wxRect(-1,-1, 0, 0); | |
75 | m_toolId = -1; | |
1154f91b BW |
76 | } |
77 | #ifndef SWIG | |
78 | wxAuiToolBarEvent(const wxAuiToolBarEvent& c) : wxNotifyEvent(c) | |
79 | { | |
9a29fe70 VZ |
80 | m_isDropdownClicked = c.m_isDropdownClicked; |
81 | m_clickPt = c.m_clickPt; | |
82 | m_rect = c.m_rect; | |
83 | m_toolId = c.m_toolId; | |
1154f91b BW |
84 | } |
85 | #endif | |
86 | wxEvent *Clone() const { return new wxAuiToolBarEvent(*this); } | |
87 | ||
9a29fe70 VZ |
88 | bool IsDropDownClicked() const { return m_isDropdownClicked; } |
89 | void SetDropDownClicked(bool c) { m_isDropdownClicked = c; } | |
9da38912 | 90 | |
9a29fe70 VZ |
91 | wxPoint GetClickPoint() const { return m_clickPt; } |
92 | void SetClickPoint(const wxPoint& p) { m_clickPt = p; } | |
9da38912 | 93 | |
9a29fe70 VZ |
94 | wxRect GetItemRect() const { return m_rect; } |
95 | void SetItemRect(const wxRect& r) { m_rect = r; } | |
9da38912 | 96 | |
9a29fe70 VZ |
97 | int GetToolId() const { return m_toolId; } |
98 | void SetToolId(int toolId) { m_toolId = toolId; } | |
9da38912 | 99 | |
e42f2c16 BW |
100 | private: |
101 | ||
9a29fe70 VZ |
102 | bool m_isDropdownClicked; |
103 | wxPoint m_clickPt; | |
104 | wxRect m_rect; | |
105 | int m_toolId; | |
9da38912 | 106 | |
1154f91b BW |
107 | private: |
108 | DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxAuiToolBarEvent) | |
1154f91b BW |
109 | }; |
110 | ||
111 | ||
112 | class WXDLLIMPEXP_AUI wxAuiToolBarItem | |
113 | { | |
e42f2c16 | 114 | friend class wxAuiToolBar; |
8e190381 | 115 | |
1154f91b BW |
116 | public: |
117 | ||
118 | wxAuiToolBarItem() | |
119 | { | |
9a29fe70 VZ |
120 | m_window = NULL; |
121 | m_sizerItem = NULL; | |
122 | m_spacerPixels = 0; | |
123 | m_toolId = 0; | |
124 | m_kind = wxITEM_NORMAL; | |
125 | m_state = 0; // normal, enabled | |
126 | m_proportion = 0; | |
127 | m_active = true; | |
128 | m_dropDown = true; | |
129 | m_sticky = true; | |
130 | m_userData = 0; | |
131 | m_alignment = wxALIGN_CENTER; | |
1154f91b | 132 | } |
9da38912 | 133 | |
1154f91b BW |
134 | wxAuiToolBarItem(const wxAuiToolBarItem& c) |
135 | { | |
136 | Assign(c); | |
137 | } | |
9da38912 | 138 | |
1154f91b BW |
139 | wxAuiToolBarItem& operator=(const wxAuiToolBarItem& c) |
140 | { | |
141 | Assign(c); | |
142 | return *this; | |
143 | } | |
9da38912 | 144 | |
1154f91b BW |
145 | void Assign(const wxAuiToolBarItem& c) |
146 | { | |
9a29fe70 VZ |
147 | m_window = c.m_window; |
148 | m_label = c.m_label; | |
149 | m_bitmap = c.m_bitmap; | |
150 | m_disabledBitmap = c.m_disabledBitmap; | |
151 | m_hoverBitmap = c.m_hoverBitmap; | |
152 | m_shortHelp = c.m_shortHelp; | |
153 | m_longHelp = c.m_longHelp; | |
154 | m_sizerItem = c.m_sizerItem; | |
155 | m_minSize = c.m_minSize; | |
156 | m_spacerPixels = c.m_spacerPixels; | |
157 | m_toolId = c.m_toolId; | |
158 | m_kind = c.m_kind; | |
159 | m_state = c.m_state; | |
160 | m_proportion = c.m_proportion; | |
161 | m_active = c.m_active; | |
162 | m_dropDown = c.m_dropDown; | |
163 | m_sticky = c.m_sticky; | |
164 | m_userData = c.m_userData; | |
165 | m_alignment = c.m_alignment; | |
1154f91b | 166 | } |
8e190381 FM |
167 | |
168 | ||
9a29fe70 VZ |
169 | void SetWindow(wxWindow* w) { m_window = w; } |
170 | wxWindow* GetWindow() { return m_window; } | |
8e190381 | 171 | |
9a29fe70 VZ |
172 | void SetId(int newId) { m_toolId = newId; } |
173 | int GetId() const { return m_toolId; } | |
8e190381 | 174 | |
9a29fe70 VZ |
175 | void SetKind(int newKind) { m_kind = newKind; } |
176 | int GetKind() const { return m_kind; } | |
8e190381 | 177 | |
9a29fe70 VZ |
178 | void SetState(int newState) { m_state = newState; } |
179 | int GetState() const { return m_state; } | |
8e190381 | 180 | |
9a29fe70 VZ |
181 | void SetSizerItem(wxSizerItem* s) { m_sizerItem = s; } |
182 | wxSizerItem* GetSizerItem() const { return m_sizerItem; } | |
8e190381 | 183 | |
9a29fe70 VZ |
184 | void SetLabel(const wxString& s) { m_label = s; } |
185 | const wxString& GetLabel() const { return m_label; } | |
8e190381 | 186 | |
9a29fe70 VZ |
187 | void SetBitmap(const wxBitmap& bmp) { m_bitmap = bmp; } |
188 | const wxBitmap& GetBitmap() const { return m_bitmap; } | |
8e190381 | 189 | |
9a29fe70 VZ |
190 | void SetDisabledBitmap(const wxBitmap& bmp) { m_disabledBitmap = bmp; } |
191 | const wxBitmap& GetDisabledBitmap() const { return m_disabledBitmap; } | |
8e190381 | 192 | |
9a29fe70 VZ |
193 | void SetHoverBitmap(const wxBitmap& bmp) { m_hoverBitmap = bmp; } |
194 | const wxBitmap& GetHoverBitmap() const { return m_hoverBitmap; } | |
8e190381 | 195 | |
9a29fe70 VZ |
196 | void SetShortHelp(const wxString& s) { m_shortHelp = s; } |
197 | const wxString& GetShortHelp() const { return m_shortHelp; } | |
8e190381 | 198 | |
9a29fe70 VZ |
199 | void SetLongHelp(const wxString& s) { m_longHelp = s; } |
200 | const wxString& GetLongHelp() const { return m_longHelp; } | |
8e190381 | 201 | |
9a29fe70 VZ |
202 | void SetMinSize(const wxSize& s) { m_minSize = s; } |
203 | const wxSize& GetMinSize() const { return m_minSize; } | |
8e190381 | 204 | |
9a29fe70 VZ |
205 | void SetSpacerPixels(int s) { m_spacerPixels = s; } |
206 | int GetSpacerPixels() const { return m_spacerPixels; } | |
8e190381 | 207 | |
9a29fe70 VZ |
208 | void SetProportion(int p) { m_proportion = p; } |
209 | int GetProportion() const { return m_proportion; } | |
8e190381 | 210 | |
9a29fe70 VZ |
211 | void SetActive(bool b) { m_active = b; } |
212 | bool IsActive() const { return m_active; } | |
8e190381 | 213 | |
72ae0b51 VZ |
214 | void SetHasDropDown(bool b) |
215 | { | |
216 | wxCHECK_RET( !b || m_kind == wxITEM_NORMAL, | |
217 | wxS("Only normal tools can have drop downs") ); | |
218 | ||
219 | m_dropDown = b; | |
220 | } | |
221 | ||
9a29fe70 | 222 | bool HasDropDown() const { return m_dropDown; } |
8e190381 | 223 | |
9a29fe70 VZ |
224 | void SetSticky(bool b) { m_sticky = b; } |
225 | bool IsSticky() const { return m_sticky; } | |
8e190381 | 226 | |
9a29fe70 VZ |
227 | void SetUserData(long l) { m_userData = l; } |
228 | long GetUserData() const { return m_userData; } | |
9da38912 | 229 | |
9a29fe70 VZ |
230 | void SetAlignment(int l) { m_alignment = l; } |
231 | int GetAlignment() const { return m_alignment; } | |
0eefa659 | 232 | |
e42f2c16 | 233 | private: |
9da38912 | 234 | |
9a29fe70 VZ |
235 | wxWindow* m_window; // item's associated window |
236 | wxString m_label; // label displayed on the item | |
237 | wxBitmap m_bitmap; // item's bitmap | |
238 | wxBitmap m_disabledBitmap; // item's disabled bitmap | |
239 | wxBitmap m_hoverBitmap; // item's hover bitmap | |
240 | wxString m_shortHelp; // short help (for tooltip) | |
241 | wxString m_longHelp; // long help (for status bar) | |
242 | wxSizerItem* m_sizerItem; // sizer item | |
243 | wxSize m_minSize; // item's minimum size | |
244 | int m_spacerPixels; // size of a spacer | |
245 | int m_toolId; // item's id | |
246 | int m_kind; // item's kind | |
247 | int m_state; // state | |
248 | int m_proportion; // proportion | |
249 | bool m_active; // true if the item is currently active | |
250 | bool m_dropDown; // true if the item has a dropdown button | |
251 | bool m_sticky; // overrides button states if true (always active) | |
252 | long m_userData; // user-specified data | |
253 | int m_alignment; // sizer alignment flag, defaults to wxCENTER, may be wxEXPAND or any other | |
1154f91b BW |
254 | }; |
255 | ||
256 | #ifndef SWIG | |
257 | WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiToolBarItem, wxAuiToolBarItemArray, WXDLLIMPEXP_AUI); | |
258 | #endif | |
259 | ||
260 | ||
261 | ||
262 | ||
263 | // tab art class | |
264 | ||
265 | class WXDLLIMPEXP_AUI wxAuiToolBarArt | |
266 | { | |
267 | public: | |
268 | ||
269 | wxAuiToolBarArt() { } | |
270 | virtual ~wxAuiToolBarArt() { } | |
9da38912 | 271 | |
1154f91b | 272 | virtual wxAuiToolBarArt* Clone() = 0; |
9da38912 | 273 | virtual void SetFlags(unsigned int flags) = 0; |
8bc10f32 | 274 | virtual unsigned int GetFlags() = 0; |
1154f91b | 275 | virtual void SetFont(const wxFont& font) = 0; |
8bc10f32 | 276 | virtual wxFont GetFont() = 0; |
1154f91b | 277 | virtual void SetTextOrientation(int orientation) = 0; |
8bc10f32 | 278 | virtual int GetTextOrientation() = 0; |
1154f91b BW |
279 | |
280 | virtual void DrawBackground( | |
281 | wxDC& dc, | |
282 | wxWindow* wnd, | |
9da38912 VZ |
283 | const wxRect& rect) = 0; |
284 | ||
526502d1 VZ |
285 | virtual void DrawPlainBackground( |
286 | wxDC& dc, | |
287 | wxWindow* wnd, | |
288 | const wxRect& rect) = 0; | |
289 | ||
1154f91b BW |
290 | virtual void DrawLabel( |
291 | wxDC& dc, | |
292 | wxWindow* wnd, | |
293 | const wxAuiToolBarItem& item, | |
294 | const wxRect& rect) = 0; | |
9da38912 | 295 | |
1154f91b BW |
296 | virtual void DrawButton( |
297 | wxDC& dc, | |
298 | wxWindow* wnd, | |
299 | const wxAuiToolBarItem& item, | |
300 | const wxRect& rect) = 0; | |
9da38912 | 301 | |
1154f91b BW |
302 | virtual void DrawDropDownButton( |
303 | wxDC& dc, | |
304 | wxWindow* wnd, | |
305 | const wxAuiToolBarItem& item, | |
306 | const wxRect& rect) = 0; | |
9da38912 | 307 | |
1154f91b BW |
308 | virtual void DrawControlLabel( |
309 | wxDC& dc, | |
310 | wxWindow* wnd, | |
311 | const wxAuiToolBarItem& item, | |
312 | const wxRect& rect) = 0; | |
9da38912 | 313 | |
1154f91b BW |
314 | virtual void DrawSeparator( |
315 | wxDC& dc, | |
316 | wxWindow* wnd, | |
317 | const wxRect& rect) = 0; | |
9da38912 | 318 | |
1154f91b BW |
319 | virtual void DrawGripper( |
320 | wxDC& dc, | |
321 | wxWindow* wnd, | |
322 | const wxRect& rect) = 0; | |
323 | ||
324 | virtual void DrawOverflowButton( | |
325 | wxDC& dc, | |
326 | wxWindow* wnd, | |
327 | const wxRect& rect, | |
328 | int state) = 0; | |
9da38912 | 329 | |
1154f91b BW |
330 | virtual wxSize GetLabelSize( |
331 | wxDC& dc, | |
332 | wxWindow* wnd, | |
333 | const wxAuiToolBarItem& item) = 0; | |
9da38912 | 334 | |
1154f91b BW |
335 | virtual wxSize GetToolSize( |
336 | wxDC& dc, | |
337 | wxWindow* wnd, | |
338 | const wxAuiToolBarItem& item) = 0; | |
9da38912 | 339 | |
9a29fe70 VZ |
340 | virtual int GetElementSize(int elementId) = 0; |
341 | virtual void SetElementSize(int elementId, int size) = 0; | |
9da38912 | 342 | |
1154f91b BW |
343 | virtual int ShowDropDown( |
344 | wxWindow* wnd, | |
345 | const wxAuiToolBarItemArray& items) = 0; | |
346 | }; | |
347 | ||
348 | ||
349 | ||
350 | class WXDLLIMPEXP_AUI wxAuiDefaultToolBarArt : public wxAuiToolBarArt | |
351 | { | |
352 | ||
353 | public: | |
354 | ||
355 | wxAuiDefaultToolBarArt(); | |
356 | virtual ~wxAuiDefaultToolBarArt(); | |
9da38912 | 357 | |
1154f91b BW |
358 | virtual wxAuiToolBarArt* Clone(); |
359 | virtual void SetFlags(unsigned int flags); | |
8bc10f32 | 360 | virtual unsigned int GetFlags(); |
1154f91b | 361 | virtual void SetFont(const wxFont& font); |
8bc10f32 | 362 | virtual wxFont GetFont(); |
1154f91b | 363 | virtual void SetTextOrientation(int orientation); |
8bc10f32 | 364 | virtual int GetTextOrientation(); |
1154f91b BW |
365 | |
366 | virtual void DrawBackground( | |
367 | wxDC& dc, | |
368 | wxWindow* wnd, | |
9da38912 VZ |
369 | const wxRect& rect); |
370 | ||
526502d1 VZ |
371 | virtual void DrawPlainBackground(wxDC& dc, |
372 | wxWindow* wnd, | |
373 | const wxRect& rect); | |
374 | ||
1154f91b BW |
375 | virtual void DrawLabel( |
376 | wxDC& dc, | |
377 | wxWindow* wnd, | |
378 | const wxAuiToolBarItem& item, | |
379 | const wxRect& rect); | |
9da38912 | 380 | |
1154f91b BW |
381 | virtual void DrawButton( |
382 | wxDC& dc, | |
383 | wxWindow* wnd, | |
384 | const wxAuiToolBarItem& item, | |
385 | const wxRect& rect); | |
9da38912 | 386 | |
1154f91b BW |
387 | virtual void DrawDropDownButton( |
388 | wxDC& dc, | |
389 | wxWindow* wnd, | |
390 | const wxAuiToolBarItem& item, | |
391 | const wxRect& rect); | |
9da38912 | 392 | |
1154f91b BW |
393 | virtual void DrawControlLabel( |
394 | wxDC& dc, | |
395 | wxWindow* wnd, | |
396 | const wxAuiToolBarItem& item, | |
397 | const wxRect& rect); | |
9da38912 | 398 | |
1154f91b BW |
399 | virtual void DrawSeparator( |
400 | wxDC& dc, | |
401 | wxWindow* wnd, | |
402 | const wxRect& rect); | |
9da38912 | 403 | |
1154f91b BW |
404 | virtual void DrawGripper( |
405 | wxDC& dc, | |
406 | wxWindow* wnd, | |
407 | const wxRect& rect); | |
9da38912 | 408 | |
1154f91b BW |
409 | virtual void DrawOverflowButton( |
410 | wxDC& dc, | |
411 | wxWindow* wnd, | |
412 | const wxRect& rect, | |
413 | int state); | |
9da38912 | 414 | |
1154f91b BW |
415 | virtual wxSize GetLabelSize( |
416 | wxDC& dc, | |
417 | wxWindow* wnd, | |
418 | const wxAuiToolBarItem& item); | |
9da38912 | 419 | |
1154f91b BW |
420 | virtual wxSize GetToolSize( |
421 | wxDC& dc, | |
422 | wxWindow* wnd, | |
423 | const wxAuiToolBarItem& item); | |
9da38912 | 424 | |
1154f91b | 425 | virtual int GetElementSize(int element); |
9a29fe70 | 426 | virtual void SetElementSize(int elementId, int size); |
1154f91b BW |
427 | |
428 | virtual int ShowDropDown(wxWindow* wnd, | |
429 | const wxAuiToolBarItemArray& items); | |
430 | ||
431 | protected: | |
432 | ||
9a29fe70 VZ |
433 | wxBitmap m_buttonDropDownBmp; |
434 | wxBitmap m_disabledButtonDropDownBmp; | |
435 | wxBitmap m_overflowBmp; | |
436 | wxBitmap m_disabledOverflowBmp; | |
437 | wxColour m_baseColour; | |
438 | wxColour m_highlightColour; | |
1154f91b BW |
439 | wxFont m_font; |
440 | unsigned int m_flags; | |
9a29fe70 | 441 | int m_textOrientation; |
9da38912 | 442 | |
9a29fe70 VZ |
443 | wxPen m_gripperPen1; |
444 | wxPen m_gripperPen2; | |
445 | wxPen m_gripperPen3; | |
9da38912 | 446 | |
9a29fe70 VZ |
447 | int m_separatorSize; |
448 | int m_gripperSize; | |
449 | int m_overflowSize; | |
1154f91b BW |
450 | }; |
451 | ||
452 | ||
453 | ||
454 | ||
455 | class WXDLLIMPEXP_AUI wxAuiToolBar : public wxControl | |
456 | { | |
457 | public: | |
46e67202 | 458 | wxAuiToolBar() { Init(); } |
1154f91b BW |
459 | |
460 | wxAuiToolBar(wxWindow* parent, | |
46e67202 VZ |
461 | wxWindowID id = wxID_ANY, |
462 | const wxPoint& pos = wxDefaultPosition, | |
1154f91b | 463 | const wxSize& size = wxDefaultSize, |
46e67202 VZ |
464 | long style = wxAUI_TB_DEFAULT_STYLE) |
465 | { | |
466 | Init(); | |
467 | Create(parent, id, pos, size, style); | |
468 | } | |
469 | ||
7bce8439 | 470 | virtual ~wxAuiToolBar(); |
9da38912 | 471 | |
46e67202 VZ |
472 | bool Create(wxWindow* parent, |
473 | wxWindowID id = wxID_ANY, | |
474 | const wxPoint& pos = wxDefaultPosition, | |
475 | const wxSize& size = wxDefaultSize, | |
873271f0 | 476 | long style = wxAUI_TB_DEFAULT_STYLE); |
46e67202 | 477 | |
a69b365f | 478 | virtual void SetWindowStyleFlag(long style); |
9da38912 | 479 | |
1154f91b BW |
480 | void SetArtProvider(wxAuiToolBarArt* art); |
481 | wxAuiToolBarArt* GetArtProvider() const; | |
482 | ||
483 | bool SetFont(const wxFont& font); | |
9da38912 | 484 | |
1154f91b | 485 | |
9a29fe70 | 486 | wxAuiToolBarItem* AddTool(int toolId, |
1154f91b BW |
487 | const wxString& label, |
488 | const wxBitmap& bitmap, | |
9a29fe70 | 489 | const wxString& shortHelpString = wxEmptyString, |
1154f91b | 490 | wxItemKind kind = wxITEM_NORMAL); |
9da38912 | 491 | |
9a29fe70 | 492 | wxAuiToolBarItem* AddTool(int toolId, |
1154f91b BW |
493 | const wxString& label, |
494 | const wxBitmap& bitmap, | |
9a29fe70 | 495 | const wxBitmap& disabledBitmap, |
1154f91b | 496 | wxItemKind kind, |
9a29fe70 VZ |
497 | const wxString& shortHelpString, |
498 | const wxString& longHelpString, | |
499 | wxObject* clientData); | |
9da38912 | 500 | |
9a29fe70 | 501 | wxAuiToolBarItem* AddTool(int toolId, |
1154f91b | 502 | const wxBitmap& bitmap, |
9a29fe70 | 503 | const wxBitmap& disabledBitmap, |
1154f91b | 504 | bool toggle = false, |
9a29fe70 VZ |
505 | wxObject* clientData = NULL, |
506 | const wxString& shortHelpString = wxEmptyString, | |
507 | const wxString& longHelpString = wxEmptyString) | |
1154f91b | 508 | { |
9a29fe70 | 509 | return AddTool(toolId, |
1154f91b BW |
510 | wxEmptyString, |
511 | bitmap, | |
9a29fe70 | 512 | disabledBitmap, |
1154f91b | 513 | toggle ? wxITEM_CHECK : wxITEM_NORMAL, |
9a29fe70 VZ |
514 | shortHelpString, |
515 | longHelpString, | |
516 | clientData); | |
1154f91b | 517 | } |
9da38912 | 518 | |
9a29fe70 | 519 | wxAuiToolBarItem* AddLabel(int toolId, |
1154f91b BW |
520 | const wxString& label = wxEmptyString, |
521 | const int width = -1); | |
7bce8439 | 522 | wxAuiToolBarItem* AddControl(wxControl* control, |
1154f91b | 523 | const wxString& label = wxEmptyString); |
7bce8439 BW |
524 | wxAuiToolBarItem* AddSeparator(); |
525 | wxAuiToolBarItem* AddSpacer(int pixels); | |
526 | wxAuiToolBarItem* AddStretchSpacer(int proportion = 1); | |
9da38912 | 527 | |
1154f91b BW |
528 | bool Realize(); |
529 | ||
9a29fe70 | 530 | wxControl* FindControl(int windowId); |
1154f91b BW |
531 | wxAuiToolBarItem* FindToolByPosition(wxCoord x, wxCoord y) const; |
532 | wxAuiToolBarItem* FindToolByIndex(int idx) const; | |
9a29fe70 | 533 | wxAuiToolBarItem* FindTool(int toolId) const; |
9da38912 | 534 | |
1154f91b BW |
535 | void ClearTools() { Clear() ; } |
536 | void Clear(); | |
9a29fe70 VZ |
537 | bool DeleteTool(int toolId); |
538 | bool DeleteByIndex(int toolId); | |
9da38912 | 539 | |
1154f91b | 540 | size_t GetToolCount() const; |
9a29fe70 VZ |
541 | int GetToolPos(int toolId) const { return GetToolIndex(toolId); } |
542 | int GetToolIndex(int toolId) const; | |
543 | bool GetToolFits(int toolId) const; | |
544 | wxRect GetToolRect(int toolId) const; | |
545 | bool GetToolFitsByIndex(int toolId) const; | |
1154f91b | 546 | bool GetToolBarFits() const; |
9da38912 | 547 | |
1154f91b BW |
548 | void SetMargins(const wxSize& size) { SetMargins(size.x, size.x, size.y, size.y); } |
549 | void SetMargins(int x, int y) { SetMargins(x, x, y, y); } | |
550 | void SetMargins(int left, int right, int top, int bottom); | |
9da38912 | 551 | |
1154f91b BW |
552 | void SetToolBitmapSize(const wxSize& size); |
553 | wxSize GetToolBitmapSize() const; | |
554 | ||
555 | bool GetOverflowVisible() const; | |
556 | void SetOverflowVisible(bool visible); | |
9da38912 | 557 | |
1154f91b BW |
558 | bool GetGripperVisible() const; |
559 | void SetGripperVisible(bool visible); | |
9da38912 | 560 | |
9a29fe70 VZ |
561 | void ToggleTool(int toolId, bool state); |
562 | bool GetToolToggled(int toolId) const; | |
9da38912 | 563 | |
9a29fe70 VZ |
564 | void EnableTool(int toolId, bool state); |
565 | bool GetToolEnabled(int toolId) const; | |
9da38912 | 566 | |
9a29fe70 VZ |
567 | void SetToolDropDown(int toolId, bool dropdown); |
568 | bool GetToolDropDown(int toolId) const; | |
1154f91b BW |
569 | |
570 | void SetToolBorderPadding(int padding); | |
571 | int GetToolBorderPadding() const; | |
9da38912 | 572 | |
1154f91b BW |
573 | void SetToolTextOrientation(int orientation); |
574 | int GetToolTextOrientation() const; | |
9da38912 | 575 | |
1154f91b BW |
576 | void SetToolPacking(int packing); |
577 | int GetToolPacking() const; | |
9da38912 | 578 | |
9a29fe70 VZ |
579 | void SetToolProportion(int toolId, int proportion); |
580 | int GetToolProportion(int toolId) const; | |
9da38912 | 581 | |
1154f91b BW |
582 | void SetToolSeparation(int separation); |
583 | int GetToolSeparation() const; | |
9da38912 | 584 | |
9a29fe70 VZ |
585 | void SetToolSticky(int toolId, bool sticky); |
586 | bool GetToolSticky(int toolId) const; | |
9da38912 | 587 | |
9a29fe70 VZ |
588 | wxString GetToolLabel(int toolId) const; |
589 | void SetToolLabel(int toolId, const wxString& label); | |
9da38912 | 590 | |
9a29fe70 VZ |
591 | wxBitmap GetToolBitmap(int toolId) const; |
592 | void SetToolBitmap(int toolId, const wxBitmap& bitmap); | |
9da38912 | 593 | |
9a29fe70 VZ |
594 | wxString GetToolShortHelp(int toolId) const; |
595 | void SetToolShortHelp(int toolId, const wxString& helpString); | |
9da38912 | 596 | |
9a29fe70 VZ |
597 | wxString GetToolLongHelp(int toolId) const; |
598 | void SetToolLongHelp(int toolId, const wxString& helpString); | |
9da38912 | 599 | |
1154f91b BW |
600 | void SetCustomOverflowItems(const wxAuiToolBarItemArray& prepend, |
601 | const wxAuiToolBarItemArray& append); | |
9da38912 | 602 | |
e5dcae09 | 603 | // get size of hint rectangle for a particular dock location |
9a29fe70 | 604 | wxSize GetHintSize(int dockDirection) const; |
e5dcae09 VZ |
605 | bool IsPaneValid(const wxAuiPaneInfo& pane) const; |
606 | ||
3ac17397 VZ |
607 | // Override to call DoIdleUpdate(). |
608 | virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE); | |
609 | ||
1154f91b | 610 | protected: |
46e67202 | 611 | void Init(); |
1154f91b BW |
612 | |
613 | virtual void OnCustomRender(wxDC& WXUNUSED(dc), | |
614 | const wxAuiToolBarItem& WXUNUSED(item), | |
615 | const wxRect& WXUNUSED(rect)) { } | |
616 | ||
617 | protected: | |
618 | ||
619 | void DoIdleUpdate(); | |
620 | void SetOrientation(int orientation); | |
621 | void SetHoverItem(wxAuiToolBarItem* item); | |
622 | void SetPressedItem(wxAuiToolBarItem* item); | |
623 | void RefreshOverflowState(); | |
9da38912 | 624 | |
1154f91b BW |
625 | int GetOverflowState() const; |
626 | wxRect GetOverflowRect() const; | |
627 | wxSize GetLabelSize(const wxString& label); | |
628 | wxAuiToolBarItem* FindToolByPositionWithPacking(wxCoord x, wxCoord y) const; | |
629 | ||
630 | void DoSetSize(int x, | |
631 | int y, | |
632 | int width, | |
633 | int height, | |
634 | int sizeFlags = wxSIZE_AUTO); | |
9da38912 | 635 | |
1154f91b BW |
636 | protected: // handlers |
637 | ||
638 | void OnSize(wxSizeEvent& evt); | |
639 | void OnIdle(wxIdleEvent& evt); | |
640 | void OnPaint(wxPaintEvent& evt); | |
641 | void OnEraseBackground(wxEraseEvent& evt); | |
642 | void OnLeftDown(wxMouseEvent& evt); | |
643 | void OnLeftUp(wxMouseEvent& evt); | |
644 | void OnRightDown(wxMouseEvent& evt); | |
645 | void OnRightUp(wxMouseEvent& evt); | |
646 | void OnMiddleDown(wxMouseEvent& evt); | |
647 | void OnMiddleUp(wxMouseEvent& evt); | |
648 | void OnMotion(wxMouseEvent& evt); | |
649 | void OnLeaveWindow(wxMouseEvent& evt); | |
4a21ea9d | 650 | void OnCaptureLost(wxMouseCaptureLostEvent& evt); |
1154f91b | 651 | void OnSetCursor(wxSetCursorEvent& evt); |
9da38912 | 652 | |
1154f91b BW |
653 | protected: |
654 | ||
655 | wxAuiToolBarItemArray m_items; // array of toolbar items | |
656 | wxAuiToolBarArt* m_art; // art provider | |
657 | wxBoxSizer* m_sizer; // main sizer for toolbar | |
9a29fe70 VZ |
658 | wxAuiToolBarItem* m_actionItem; // item that's being acted upon (pressed) |
659 | wxAuiToolBarItem* m_tipItem; // item that has its tooltip shown | |
1154f91b | 660 | wxBitmap m_bitmap; // double-buffer bitmap |
9a29fe70 VZ |
661 | wxSizerItem* m_gripperSizerItem; |
662 | wxSizerItem* m_overflowSizerItem; | |
663 | wxSize m_absoluteMinSize; | |
664 | wxPoint m_actionPos; // position of left-mouse down | |
665 | wxAuiToolBarItemArray m_customOverflowPrepend; | |
666 | wxAuiToolBarItemArray m_customOverflowAppend; | |
667 | ||
668 | int m_buttonWidth; | |
669 | int m_buttonHeight; | |
670 | int m_sizerElementCount; | |
671 | int m_leftPadding; | |
672 | int m_rightPadding; | |
673 | int m_topPadding; | |
674 | int m_bottomPadding; | |
675 | int m_toolPacking; | |
676 | int m_toolBorderPadding; | |
677 | int m_toolTextOrientation; | |
678 | int m_overflowState; | |
1154f91b | 679 | bool m_dragging; |
9a29fe70 VZ |
680 | bool m_gripperVisible; |
681 | bool m_overflowVisible; | |
9da38912 | 682 | |
e5dcae09 VZ |
683 | bool RealizeHelper(wxClientDC& dc, bool horizontal); |
684 | static bool IsPaneValid(long style, const wxAuiPaneInfo& pane); | |
685 | bool IsPaneValid(long style) const; | |
686 | void SetArtFlags() const; | |
687 | wxOrientation m_orientation; | |
688 | wxSize m_horzHintSize; | |
689 | wxSize m_vertHintSize; | |
690 | ||
4a21ea9d VZ |
691 | private: |
692 | // Common part of OnLeaveWindow() and OnCaptureLost(). | |
693 | void DoResetMouseState(); | |
694 | ||
1154f91b BW |
695 | DECLARE_EVENT_TABLE() |
696 | DECLARE_CLASS(wxAuiToolBar) | |
697 | }; | |
698 | ||
699 | ||
700 | ||
701 | ||
702 | // wx event machinery | |
703 | ||
704 | #ifndef SWIG | |
705 | ||
ce7fe42e VZ |
706 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_AUITOOLBAR_TOOL_DROPDOWN, wxAuiToolBarEvent ); |
707 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_AUITOOLBAR_OVERFLOW_CLICK, wxAuiToolBarEvent ); | |
708 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_AUITOOLBAR_RIGHT_CLICK, wxAuiToolBarEvent ); | |
709 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_AUITOOLBAR_MIDDLE_CLICK, wxAuiToolBarEvent ); | |
710 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_AUITOOLBAR_BEGIN_DRAG, wxAuiToolBarEvent ); | |
1154f91b BW |
711 | |
712 | typedef void (wxEvtHandler::*wxAuiToolBarEventFunction)(wxAuiToolBarEvent&); | |
713 | ||
714 | #define wxAuiToolBarEventHandler(func) \ | |
3c778901 | 715 | wxEVENT_HANDLER_CAST(wxAuiToolBarEventFunction, func) |
9da38912 | 716 | |
1154f91b | 717 | #define EVT_AUITOOLBAR_TOOL_DROPDOWN(winid, fn) \ |
ce7fe42e | 718 | wx__DECLARE_EVT1(wxEVT_AUITOOLBAR_TOOL_DROPDOWN, winid, wxAuiToolBarEventHandler(fn)) |
1154f91b | 719 | #define EVT_AUITOOLBAR_OVERFLOW_CLICK(winid, fn) \ |
ce7fe42e | 720 | wx__DECLARE_EVT1(wxEVT_AUITOOLBAR_OVERFLOW_CLICK, winid, wxAuiToolBarEventHandler(fn)) |
1154f91b | 721 | #define EVT_AUITOOLBAR_RIGHT_CLICK(winid, fn) \ |
ce7fe42e | 722 | wx__DECLARE_EVT1(wxEVT_AUITOOLBAR_RIGHT_CLICK, winid, wxAuiToolBarEventHandler(fn)) |
1154f91b | 723 | #define EVT_AUITOOLBAR_MIDDLE_CLICK(winid, fn) \ |
ce7fe42e | 724 | wx__DECLARE_EVT1(wxEVT_AUITOOLBAR_MIDDLE_CLICK, winid, wxAuiToolBarEventHandler(fn)) |
1154f91b | 725 | #define EVT_AUITOOLBAR_BEGIN_DRAG(winid, fn) \ |
ce7fe42e | 726 | wx__DECLARE_EVT1(wxEVT_AUITOOLBAR_BEGIN_DRAG, winid, wxAuiToolBarEventHandler(fn)) |
1154f91b BW |
727 | |
728 | #else | |
729 | ||
730 | // wxpython/swig event work | |
ce7fe42e VZ |
731 | %constant wxEventType wxEVT_AUITOOLBAR_TOOL_DROPDOWN; |
732 | %constant wxEventType wxEVT_AUITOOLBAR_OVERFLOW_CLICK; | |
733 | %constant wxEventType wxEVT_AUITOOLBAR_RIGHT_CLICK; | |
734 | %constant wxEventType wxEVT_AUITOOLBAR_MIDDLE_CLICK; | |
735 | %constant wxEventType wxEVT_AUITOOLBAR_BEGIN_DRAG; | |
1154f91b BW |
736 | |
737 | %pythoncode { | |
ce7fe42e VZ |
738 | EVT_AUITOOLBAR_TOOL_DROPDOWN = wx.PyEventBinder( wxEVT_AUITOOLBAR_TOOL_DROPDOWN, 1 ) |
739 | EVT_AUITOOLBAR_OVERFLOW_CLICK = wx.PyEventBinder( wxEVT_AUITOOLBAR_OVERFLOW_CLICK, 1 ) | |
740 | EVT_AUITOOLBAR_RIGHT_CLICK = wx.PyEventBinder( wxEVT_AUITOOLBAR_RIGHT_CLICK, 1 ) | |
741 | EVT_AUITOOLBAR_MIDDLE_CLICK = wx.PyEventBinder( wxEVT_AUITOOLBAR_MIDDLE_CLICK, 1 ) | |
742 | EVT_AUITOOLBAR_BEGIN_DRAG = wx.PyEventBinder( wxEVT_AUITOOLBAR_BEGIN_DRAG, 1 ) | |
1154f91b BW |
743 | } |
744 | #endif // SWIG | |
745 | ||
ce7fe42e VZ |
746 | // old wxEVT_COMMAND_* constants |
747 | #define wxEVT_COMMAND_AUITOOLBAR_TOOL_DROPDOWN wxEVT_AUITOOLBAR_TOOL_DROPDOWN | |
748 | #define wxEVT_COMMAND_AUITOOLBAR_OVERFLOW_CLICK wxEVT_AUITOOLBAR_OVERFLOW_CLICK | |
749 | #define wxEVT_COMMAND_AUITOOLBAR_RIGHT_CLICK wxEVT_AUITOOLBAR_RIGHT_CLICK | |
750 | #define wxEVT_COMMAND_AUITOOLBAR_MIDDLE_CLICK wxEVT_AUITOOLBAR_MIDDLE_CLICK | |
751 | #define wxEVT_COMMAND_AUITOOLBAR_BEGIN_DRAG wxEVT_AUITOOLBAR_BEGIN_DRAG | |
752 | ||
1154f91b BW |
753 | #endif // wxUSE_AUI |
754 | #endif // _WX_AUIBAR_H_ | |
755 |