]> git.saurik.com Git - wxWidgets.git/blame - include/wx/aui/framemanager.h
fix compilation both for Robert's cross-compiler and for all normal compilers by...
[wxWidgets.git] / include / wx / aui / framemanager.h
CommitLineData
50acee04 1///////////////////////////////////////////////////////////////////////////////
be66f18e 2// Name: wx/aui/framemanager.h
50acee04
JS
3// Purpose: wxaui: wx advanced user interface - docking window manager
4// Author: Benjamin I. Williams
5// Modified by:
6// Created: 2005-05-17
be66f18e 7// RCS-ID: $Id$
50acee04
JS
8// Copyright: (C) Copyright 2005, Kirix Corporation, All Rights Reserved.
9// Licence: wxWindows Library Licence, Version 3.1
10///////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_FRAMEMANAGER_H_
13#define _WX_FRAMEMANAGER_H_
14
15// ----------------------------------------------------------------------------
16// headers
17// ----------------------------------------------------------------------------
18
19#include "wx/defs.h"
20
21#if wxUSE_AUI
22
08469b1f
JS
23#include "wx/dynarray.h"
24#include "wx/gdicmn.h"
25#include "wx/window.h"
26#include "wx/timer.h"
27#include "wx/sizer.h"
28
2cc833a1 29enum wxFrameManagerDock
50acee04
JS
30{
31 wxAUI_DOCK_NONE = 0,
32 wxAUI_DOCK_TOP = 1,
33 wxAUI_DOCK_RIGHT = 2,
34 wxAUI_DOCK_BOTTOM = 3,
35 wxAUI_DOCK_LEFT = 4,
36 wxAUI_DOCK_CENTER = 5,
37 wxAUI_DOCK_CENTRE = wxAUI_DOCK_CENTER
38};
39
2cc833a1 40enum wxFrameManagerOption
50acee04
JS
41{
42 wxAUI_MGR_ALLOW_FLOATING = 1 << 0,
43 wxAUI_MGR_ALLOW_ACTIVE_PANE = 1 << 1,
44 wxAUI_MGR_TRANSPARENT_DRAG = 1 << 2,
45 wxAUI_MGR_TRANSPARENT_HINT = 1 << 3,
46 wxAUI_MGR_TRANSPARENT_HINT_FADE = 1 << 4,
7a5b04a6
AB
47 // The venetian blind effect is ONLY used when the wxAUI_MGR_TRANSPARENT_HINT has been used, but
48 // at runtime we determine we cannot use transparency (because, for instance, the OS does not support it).
49 // setting this flag drops back in such circumstances (only) to the behaviour without wxAUI_MGR_TRANSPARENT_HINT
50 wxAUI_MGR_DISABLE_VENETIAN_BLINDS = 1 << 5,
5826659c 51 wxAUI_MGR_DISABLE_VENETIAN_BLINDS_FADE = 1 << 6,
50acee04
JS
52
53 wxAUI_MGR_DEFAULT = wxAUI_MGR_ALLOW_FLOATING |
54 wxAUI_MGR_TRANSPARENT_HINT |
5826659c
AB
55 wxAUI_MGR_TRANSPARENT_HINT_FADE |
56 wxAUI_MGR_DISABLE_VENETIAN_BLINDS_FADE
50acee04
JS
57};
58
2cc833a1 59enum wxPaneDockArtSetting
50acee04
JS
60{
61 wxAUI_ART_SASH_SIZE = 0,
62 wxAUI_ART_CAPTION_SIZE = 1,
63 wxAUI_ART_GRIPPER_SIZE = 2,
64 wxAUI_ART_PANE_BORDER_SIZE = 3,
65 wxAUI_ART_PANE_BUTTON_SIZE = 4,
66 wxAUI_ART_BACKGROUND_COLOUR = 5,
67 wxAUI_ART_SASH_COLOUR = 6,
68 wxAUI_ART_ACTIVE_CAPTION_COLOUR = 7,
69 wxAUI_ART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8,
70 wxAUI_ART_INACTIVE_CAPTION_COLOUR = 9,
71 wxAUI_ART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10,
72 wxAUI_ART_ACTIVE_CAPTION_TEXT_COLOUR = 11,
73 wxAUI_ART_INACTIVE_CAPTION_TEXT_COLOUR = 12,
74 wxAUI_ART_BORDER_COLOUR = 13,
75 wxAUI_ART_GRIPPER_COLOUR = 14,
76 wxAUI_ART_CAPTION_FONT = 15,
77 wxAUI_ART_GRADIENT_TYPE = 16
78};
79
2cc833a1 80enum wxPaneDockArtGradients
50acee04
JS
81{
82 wxAUI_GRADIENT_NONE = 0,
83 wxAUI_GRADIENT_VERTICAL = 1,
84 wxAUI_GRADIENT_HORIZONTAL = 2
85};
86
2cc833a1 87enum wxPaneButtonState
50acee04
JS
88{
89 wxAUI_BUTTON_STATE_NORMAL = 0,
90 wxAUI_BUTTON_STATE_HOVER = 1,
91 wxAUI_BUTTON_STATE_PRESSED = 2
92};
93
2cc833a1 94enum wxPaneInsertLevel
50acee04
JS
95{
96 wxAUI_INSERT_PANE = 0,
97 wxAUI_INSERT_ROW = 1,
98 wxAUI_INSERT_DOCK = 2
99};
100
101
102
103// forwards and array declarations
104class wxDockUIPart;
105class wxPaneButton;
106class wxPaneInfo;
107class wxDockInfo;
108class wxDockArt;
109class wxFrameManagerEvent;
110
06d4c4d6 111#ifndef SWIG
063708fc
MW
112WX_DECLARE_USER_EXPORTED_OBJARRAY(wxDockInfo, wxDockInfoArray, WXDLLIMPEXP_AUI);
113WX_DECLARE_USER_EXPORTED_OBJARRAY(wxDockUIPart, wxDockUIPartArray, WXDLLIMPEXP_AUI);
114WX_DECLARE_USER_EXPORTED_OBJARRAY(wxPaneButton, wxPaneButtonArray, WXDLLIMPEXP_AUI);
115WX_DECLARE_USER_EXPORTED_OBJARRAY(wxPaneInfo, wxPaneInfoArray, WXDLLIMPEXP_AUI);
50acee04
JS
116WX_DEFINE_ARRAY_PTR(wxPaneInfo*, wxPaneInfoPtrArray);
117WX_DEFINE_ARRAY_PTR(wxDockInfo*, wxDockInfoPtrArray);
06d4c4d6 118#endif // SWIG
50acee04 119
06d4c4d6
RD
120extern WXDLLIMPEXP_AUI wxDockInfo wxNullDockInfo;
121extern WXDLLIMPEXP_AUI wxPaneInfo wxNullPaneInfo;
50acee04
JS
122
123
124
125class WXDLLIMPEXP_AUI wxPaneInfo
126{
127public:
128
129 wxPaneInfo()
130 {
131 window = NULL;
132 frame = NULL;
133 state = 0;
134 dock_direction = wxAUI_DOCK_LEFT;
135 dock_layer = 0;
136 dock_row = 0;
137 dock_pos = 0;
138 floating_pos = wxDefaultPosition;
139 floating_size = wxDefaultSize;
140 best_size = wxDefaultSize;
141 min_size = wxDefaultSize;
142 max_size = wxDefaultSize;
143 dock_proportion = 0;
be66f18e 144
50acee04
JS
145 DefaultPane();
146 }
147
06d4c4d6
RD
148 ~wxPaneInfo() {}
149
150#ifndef SWIG
50acee04
JS
151 wxPaneInfo(const wxPaneInfo& c)
152 {
153 name = c.name;
154 caption = c.caption;
155 window = c.window;
156 frame = c.frame;
157 state = c.state;
158 dock_direction = c.dock_direction;
159 dock_layer = c.dock_layer;
160 dock_row = c.dock_row;
161 dock_pos = c.dock_pos;
162 best_size = c.best_size;
163 min_size = c.min_size;
164 max_size = c.max_size;
165 floating_pos = c.floating_pos;
166 floating_size = c.floating_size;
167 dock_proportion = c.dock_proportion;
168 buttons = c.buttons;
169 rect = c.rect;
170 }
171
172 wxPaneInfo& operator=(const wxPaneInfo& c)
173 {
174 name = c.name;
175 caption = c.caption;
176 window = c.window;
177 frame = c.frame;
178 state = c.state;
179 dock_direction = c.dock_direction;
180 dock_layer = c.dock_layer;
181 dock_row = c.dock_row;
182 dock_pos = c.dock_pos;
183 best_size = c.best_size;
184 min_size = c.min_size;
185 max_size = c.max_size;
186 floating_pos = c.floating_pos;
187 floating_size = c.floating_size;
188 dock_proportion = c.dock_proportion;
189 buttons = c.buttons;
190 rect = c.rect;
191 return *this;
192 }
06d4c4d6 193#endif // SWIG
75c8d68f
AB
194
195 // Write the safe parts of a newly loaded PaneInfo structure "source" into "this"
196 // used on loading perspectives etc.
197 void SafeSet(wxPaneInfo source)
198 {
199 // note source is not passed by reference so we can overwrite, to keep the
200 // unsafe bits of "dest"
201 source.window = window;
202 source.frame = frame;
203 source.buttons = buttons;
204 // now assign
205 *this = source;
206 }
207
50acee04
JS
208 bool IsOk() const { return (window != NULL) ? true : false; }
209 bool IsFixed() const { return !HasFlag(optionResizable); }
210 bool IsResizable() const { return HasFlag(optionResizable); }
211 bool IsShown() const { return !HasFlag(optionHidden); }
212 bool IsFloating() const { return HasFlag(optionFloating); }
213 bool IsDocked() const { return !HasFlag(optionFloating); }
214 bool IsToolbar() const { return HasFlag(optionToolbar); }
215 bool IsTopDockable() const { return HasFlag(optionTopDockable); }
216 bool IsBottomDockable() const { return HasFlag(optionBottomDockable); }
217 bool IsLeftDockable() const { return HasFlag(optionLeftDockable); }
218 bool IsRightDockable() const { return HasFlag(optionRightDockable); }
219 bool IsFloatable() const { return HasFlag(optionFloatable); }
220 bool IsMovable() const { return HasFlag(optionMovable); }
221 bool HasCaption() const { return HasFlag(optionCaption); }
222 bool HasGripper() const { return HasFlag(optionGripper); }
223 bool HasBorder() const { return HasFlag(optionPaneBorder); }
224 bool HasCloseButton() const { return HasFlag(buttonClose); }
225 bool HasMaximizeButton() const { return HasFlag(buttonMaximize); }
226 bool HasMinimizeButton() const { return HasFlag(buttonMinimize); }
227 bool HasPinButton() const { return HasFlag(buttonPin); }
228 bool HasGripperTop() const { return HasFlag(optionGripperTop); }
be66f18e 229
06d4c4d6
RD
230#ifdef SWIG
231 %typemap(out) wxPaneInfo& { $result = $self; Py_INCREF($result); }
232#endif
50acee04
JS
233 wxPaneInfo& Window(wxWindow* w) { window = w; return *this; }
234 wxPaneInfo& Name(const wxString& n) { name = n; return *this; }
235 wxPaneInfo& Caption(const wxString& c) { caption = c; return *this; }
236 wxPaneInfo& Left() { dock_direction = wxAUI_DOCK_LEFT; return *this; }
237 wxPaneInfo& Right() { dock_direction = wxAUI_DOCK_RIGHT; return *this; }
238 wxPaneInfo& Top() { dock_direction = wxAUI_DOCK_TOP; return *this; }
239 wxPaneInfo& Bottom() { dock_direction = wxAUI_DOCK_BOTTOM; return *this; }
240 wxPaneInfo& Center() { dock_direction = wxAUI_DOCK_CENTER; return *this; }
241 wxPaneInfo& Centre() { dock_direction = wxAUI_DOCK_CENTRE; return *this; }
242 wxPaneInfo& Direction(int direction) { dock_direction = direction; return *this; }
243 wxPaneInfo& Layer(int layer) { dock_layer = layer; return *this; }
244 wxPaneInfo& Row(int row) { dock_row = row; return *this; }
245 wxPaneInfo& Position(int pos) { dock_pos = pos; return *this; }
246 wxPaneInfo& BestSize(const wxSize& size) { best_size = size; return *this; }
247 wxPaneInfo& MinSize(const wxSize& size) { min_size = size; return *this; }
248 wxPaneInfo& MaxSize(const wxSize& size) { max_size = size; return *this; }
249 wxPaneInfo& BestSize(int x, int y) { best_size.Set(x,y); return *this; }
250 wxPaneInfo& MinSize(int x, int y) { min_size.Set(x,y); return *this; }
251 wxPaneInfo& MaxSize(int x, int y) { max_size.Set(x,y); return *this; }
252 wxPaneInfo& FloatingPosition(const wxPoint& pos) { floating_pos = pos; return *this; }
253 wxPaneInfo& FloatingPosition(int x, int y) { floating_pos.x = x; floating_pos.y = y; return *this; }
254 wxPaneInfo& FloatingSize(const wxSize& size) { floating_size = size; return *this; }
255 wxPaneInfo& FloatingSize(int x, int y) { floating_size.Set(x,y); return *this; }
256 wxPaneInfo& Fixed() { return SetFlag(optionResizable, false); }
257 wxPaneInfo& Resizable(bool resizable = true) { return SetFlag(optionResizable, resizable); }
258 wxPaneInfo& Dock() { return SetFlag(optionFloating, false); }
259 wxPaneInfo& Float() { return SetFlag(optionFloating, true); }
260 wxPaneInfo& Hide() { return SetFlag(optionHidden, true); }
261 wxPaneInfo& Show(bool show = true) { return SetFlag(optionHidden, !show); }
262 wxPaneInfo& CaptionVisible(bool visible = true) { return SetFlag(optionCaption, visible); }
263 wxPaneInfo& PaneBorder(bool visible = true) { return SetFlag(optionPaneBorder, visible); }
264 wxPaneInfo& Gripper(bool visible = true) { return SetFlag(optionGripper, visible); }
265 wxPaneInfo& GripperTop(bool attop = true) { return SetFlag(optionGripperTop, attop); }
be66f18e 266 wxPaneInfo& CloseButton(bool visible = true) { return SetFlag(buttonClose, visible); }
50acee04
JS
267 wxPaneInfo& MaximizeButton(bool visible = true) { return SetFlag(buttonMaximize, visible); }
268 wxPaneInfo& MinimizeButton(bool visible = true) { return SetFlag(buttonMinimize, visible); }
269 wxPaneInfo& PinButton(bool visible = true) { return SetFlag(buttonPin, visible); }
270 wxPaneInfo& DestroyOnClose(bool b = true) { return SetFlag(optionDestroyOnClose, b); }
271 wxPaneInfo& TopDockable(bool b = true) { return SetFlag(optionTopDockable, b); }
272 wxPaneInfo& BottomDockable(bool b = true) { return SetFlag(optionBottomDockable, b); }
273 wxPaneInfo& LeftDockable(bool b = true) { return SetFlag(optionLeftDockable, b); }
be66f18e 274 wxPaneInfo& RightDockable(bool b = true) { return SetFlag(optionRightDockable, b); }
50acee04
JS
275 wxPaneInfo& Floatable(bool b = true) { return SetFlag(optionFloatable, b); }
276 wxPaneInfo& Movable(bool b = true) { return SetFlag(optionMovable, b); }
277 wxPaneInfo& Dockable(bool b = true)
278 {
279 return TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b);
280 }
281
282 wxPaneInfo& DefaultPane()
283 {
284 state |= optionTopDockable | optionBottomDockable |
285 optionLeftDockable | optionRightDockable |
286 optionFloatable | optionMovable | optionResizable |
287 optionCaption | optionPaneBorder | buttonClose;
288 return *this;
289 }
be66f18e 290
50acee04
JS
291 wxPaneInfo& CentrePane() { return CenterPane(); }
292 wxPaneInfo& CenterPane()
293 {
294 state = 0;
295 return Center().PaneBorder().Resizable();
296 }
be66f18e 297
50acee04
JS
298 wxPaneInfo& ToolbarPane()
299 {
300 DefaultPane();
301 state |= (optionToolbar | optionGripper);
302 state &= ~(optionResizable | optionCaption);
303 if (dock_layer == 0)
304 dock_layer = 10;
305 return *this;
306 }
307
308 wxPaneInfo& SetFlag(unsigned int flag, bool option_state)
309 {
310 if (option_state)
311 state |= flag;
312 else
313 state &= ~flag;
314 return *this;
315 }
be66f18e 316
50acee04
JS
317 bool HasFlag(unsigned int flag) const
318 {
319 return (state & flag) ? true:false;
320 }
321
06d4c4d6
RD
322#ifdef SWIG
323 %typemap(out) wxPaneInfo& ;
324#endif
325
50acee04
JS
326public:
327
328 enum wxPaneState
329 {
330 optionFloating = 1 << 0,
331 optionHidden = 1 << 1,
332 optionLeftDockable = 1 << 2,
333 optionRightDockable = 1 << 3,
334 optionTopDockable = 1 << 4,
335 optionBottomDockable = 1 << 5,
336 optionFloatable = 1 << 6,
337 optionMovable = 1 << 7,
338 optionResizable = 1 << 8,
339 optionPaneBorder = 1 << 9,
340 optionCaption = 1 << 10,
341 optionGripper = 1 << 11,
342 optionDestroyOnClose = 1 << 12,
343 optionToolbar = 1 << 13,
344 optionActive = 1 << 14,
be66f18e 345 optionGripperTop = 1 << 15,
50acee04
JS
346
347 buttonClose = 1 << 24,
348 buttonMaximize = 1 << 25,
349 buttonMinimize = 1 << 26,
350 buttonPin = 1 << 27,
351 buttonCustom1 = 1 << 28,
352 buttonCustom2 = 1 << 29,
353 buttonCustom3 = 1 << 30,
354 actionPane = 1 << 31 // used internally
355 };
356
357public:
358 wxString name; // name of the pane
359 wxString caption; // caption displayed on the window
360
361 wxWindow* window; // window that is in this pane
50f3c41d 362 wxFrame* frame; // floating frame window that holds the pane
50acee04
JS
363 unsigned int state; // a combination of wxPaneState values
364
365 int dock_direction; // dock direction (top, bottom, left, right, center)
366 int dock_layer; // layer number (0 = innermost layer)
367 int dock_row; // row number on the docking bar (0 = first row)
368 int dock_pos; // position inside the row (0 = first position)
369
370 wxSize best_size; // size that the layout engine will prefer
371 wxSize min_size; // minimum size the pane window can tolerate
372 wxSize max_size; // maximum size the pane window can tolerate
373
374 wxPoint floating_pos; // position while floating
375 wxSize floating_size; // size while floating
376 int dock_proportion; // proportion while docked
377
378 wxPaneButtonArray buttons; // buttons on the pane
379
380 wxRect rect; // current rectangle (populated by wxAUI)
381};
382
383
384
385
386
387class WXDLLIMPEXP_AUI wxFrameManager : public wxEvtHandler
388{
389friend class wxFloatingPane;
390
391public:
392
461125ea 393 wxFrameManager(wxWindow* managed_wnd = NULL,
50acee04
JS
394 unsigned int flags = wxAUI_MGR_DEFAULT);
395 virtual ~wxFrameManager();
396 void UnInit();
be66f18e 397
50acee04
JS
398 void SetFlags(unsigned int flags);
399 unsigned int GetFlags() const;
be66f18e 400
461125ea
BW
401 void SetManagedWindow(wxWindow* managed_wnd);
402 wxWindow* GetManagedWindow() const;
be66f18e 403
af672b5a
RD
404#ifdef SWIG
405 %disownarg( wxDockArt* art_provider );
406#endif
50acee04
JS
407 void SetArtProvider(wxDockArt* art_provider);
408 wxDockArt* GetArtProvider() const;
409
410 wxPaneInfo& GetPane(wxWindow* window);
411 wxPaneInfo& GetPane(const wxString& name);
412 wxPaneInfoArray& GetAllPanes();
413
414 bool AddPane(wxWindow* window,
415 const wxPaneInfo& pane_info);
0603bb28
BW
416
417 bool AddPane(wxWindow* window,
418 const wxPaneInfo& pane_info,
419 const wxPoint& drop_pos);
be66f18e 420
50acee04
JS
421 bool AddPane(wxWindow* window,
422 int direction = wxLEFT,
423 const wxString& caption = wxEmptyString);
be66f18e 424
50acee04 425 bool InsertPane(wxWindow* window,
af672b5a 426 const wxPaneInfo& insert_location,
50acee04 427 int insert_level = wxAUI_INSERT_PANE);
be66f18e 428
50acee04
JS
429 bool DetachPane(wxWindow* window);
430
75c8d68f 431 wxString SavePaneInfo(wxPaneInfo& pane);
13201165 432 void LoadPaneInfo(wxString pane_part, wxPaneInfo &pane);
75c8d68f 433
50acee04 434 wxString SavePerspective();
be66f18e 435
50acee04
JS
436 bool LoadPerspective(const wxString& perspective,
437 bool update = true);
be66f18e 438
50acee04
JS
439 void Update();
440
0603bb28
BW
441
442public:
443
444 void DrawHintRect(wxWindow* pane_window,
445 const wxPoint& pt,
446 const wxPoint& offset);
447 virtual void ShowHint(const wxRect& rect);
448 virtual void HideHint();
449
461125ea
BW
450public:
451
452 // deprecated -- please use SetManagedWindow() and
453 // and GetManagedWindow() instead
454
455 wxDEPRECATED( void SetFrame(wxFrame* frame) );
456 wxDEPRECATED( wxFrame* GetFrame() const );
457
e4542fa6 458protected:
50acee04 459
50acee04 460
0603bb28 461
50acee04
JS
462 void DoFrameLayout();
463
464 void LayoutAddPane(wxSizer* container,
465 wxDockInfo& dock,
466 wxPaneInfo& pane,
467 wxDockUIPartArray& uiparts,
468 bool spacer_only);
469
470 void LayoutAddDock(wxSizer* container,
471 wxDockInfo& dock,
472 wxDockUIPartArray& uiparts,
473 bool spacer_only);
474
475 wxSizer* LayoutAll(wxPaneInfoArray& panes,
476 wxDockInfoArray& docks,
477 wxDockUIPartArray& uiparts,
478 bool spacer_only = false);
479
0d02dd54
AB
480 virtual bool ProcessDockResult(wxPaneInfo& target,
481 const wxPaneInfo& new_pos);
482
50acee04
JS
483 bool DoDrop(wxDockInfoArray& docks,
484 wxPaneInfoArray& panes,
485 wxPaneInfo& drop,
486 const wxPoint& pt,
487 const wxPoint& action_offset = wxPoint(0,0));
488
489 wxPaneInfo& LookupPane(wxWindow* window);
490 wxPaneInfo& LookupPane(const wxString& name);
491 wxDockUIPart* HitTest(int x, int y);
492 wxDockUIPart* GetPanePart(wxWindow* pane);
493 int GetDockPixelOffset(wxPaneInfo& test);
494 void OnFloatingPaneMoveStart(wxWindow* window);
322c5ec4
RR
495 void OnFloatingPaneMoving(wxWindow* window, wxDirection dir );
496 void OnFloatingPaneMoved(wxWindow* window, wxDirection dir);
50acee04 497 void OnFloatingPaneActivated(wxWindow* window);
58754643 498 void OnFloatingPaneClosed(wxWindow* window, wxCloseEvent& evt);
50acee04
JS
499 void OnFloatingPaneResized(wxWindow* window, const wxSize& size);
500 void Render(wxDC* dc);
501 void Repaint(wxDC* dc = NULL);
502 void ProcessMgrEvent(wxFrameManagerEvent& event);
503 void UpdateButtonOnScreen(wxDockUIPart* button_ui_part,
504 const wxMouseEvent& event);
505 void GetPanePositionsAndSizes(wxDockInfo& dock,
506 wxArrayInt& positions,
507 wxArrayInt& sizes);
0603bb28 508
50acee04 509
673727f3
BW
510public:
511
512 // public events (which can be invoked externally)
513 void OnRender(wxFrameManagerEvent& evt);
514 void OnPaneButton(wxFrameManagerEvent& evt);
515
e4542fa6 516protected:
50acee04 517
673727f3
BW
518 // protected events
519 void OnPaint(wxPaintEvent& evt);
520 void OnEraseBackground(wxEraseEvent& evt);
521 void OnSize(wxSizeEvent& evt);
522 void OnSetCursor(wxSetCursorEvent& evt);
523 void OnLeftDown(wxMouseEvent& evt);
524 void OnLeftUp(wxMouseEvent& evt);
525 void OnMotion(wxMouseEvent& evt);
526 void OnLeaveWindow(wxMouseEvent& evt);
527 void OnChildFocus(wxChildFocusEvent& evt);
528 void OnHintFadeTimer(wxTimerEvent& evt);
50acee04 529
e4542fa6 530protected:
50acee04
JS
531
532 enum
533 {
534 actionNone = 0,
535 actionResize,
536 actionClickButton,
537 actionClickCaption,
538 actionDragToolbarPane,
539 actionDragFloatingPane
540 };
541
e4542fa6 542protected:
50acee04 543
a189504e 544 wxWindow* m_frame; // the window being managed
50acee04
JS
545 wxDockArt* m_art; // dock art object which does all drawing
546 unsigned int m_flags; // manager flags wxAUI_MGR_*
547
548 wxPaneInfoArray m_panes; // array of panes structures
549 wxDockInfoArray m_docks; // array of docks structures
550 wxDockUIPartArray m_uiparts; // array of UI parts (captions, buttons, etc)
551
552 int m_action; // current mouse action
553 wxPoint m_action_start; // position where the action click started
554 wxPoint m_action_offset; // offset from upper left of the item clicked
555 wxDockUIPart* m_action_part; // ptr to the part the action happened to
556 wxWindow* m_action_window; // action frame or window (NULL if none)
557 wxRect m_action_hintrect; // hint rectangle for the action
558 wxDockUIPart* m_hover_button;// button uipart being hovered over
559 wxRect m_last_hint; // last hint rectangle
560 wxPoint m_last_mouse_move; // last mouse move position (see OnMotion)
561
50f3c41d
RD
562 wxFrame* m_hint_wnd; // transparent hint window, if supported by platform
563 wxTimer m_hint_fadetimer; // transparent fade timer
db847131 564 wxByte m_hint_fadeamt; // transparent fade amount
7a5b04a6 565 wxByte m_hint_fademax; // maximum value of hint fade
be66f18e 566
06d4c4d6 567#ifndef SWIG
50acee04 568 DECLARE_EVENT_TABLE()
06d4c4d6 569#endif // SWIG
50acee04
JS
570};
571
572
573
574// event declarations/classes
575
576class WXDLLIMPEXP_AUI wxFrameManagerEvent : public wxEvent
577{
578public:
af672b5a 579 wxFrameManagerEvent(wxEventType type=wxEVT_NULL) : wxEvent(0, type)
50acee04
JS
580 {
581 pane = NULL;
582 button = 0;
58754643
BW
583 veto_flag = false;
584 canveto_flag = true;
673727f3 585 dc = NULL;
50acee04 586 }
06d4c4d6 587#ifndef SWIG
50acee04
JS
588 wxFrameManagerEvent(const wxFrameManagerEvent& c) : wxEvent(c)
589 {
590 pane = c.pane;
591 button = c.button;
58754643
BW
592 veto_flag = c.veto_flag;
593 canveto_flag = c.canveto_flag;
673727f3 594 dc = c.dc;
50acee04 595 }
06d4c4d6 596#endif
50acee04
JS
597 wxEvent *Clone() const { return new wxFrameManagerEvent(*this); }
598
599 void SetPane(wxPaneInfo* p) { pane = p; }
600 void SetButton(int b) { button = b; }
673727f3
BW
601 void SetDC(wxDC* pdc) { dc = pdc; }
602
50acee04
JS
603 wxPaneInfo* GetPane() { return pane; }
604 int GetButton() { return button; }
673727f3 605 wxDC* GetDC() { return dc; }
58754643
BW
606
607 void Veto(bool veto = true) { veto_flag = veto; }
608 bool GetVeto() const { return veto_flag; }
609 void SetCanVeto(bool can_veto) { canveto_flag = can_veto; }
610 bool CanVeto() const { return canveto_flag && veto_flag; }
611
50acee04
JS
612public:
613 wxPaneInfo* pane;
614 int button;
58754643
BW
615 bool veto_flag;
616 bool canveto_flag;
673727f3 617 wxDC* dc;
af672b5a
RD
618
619#ifndef SWIG
620private:
621 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFrameManagerEvent)
622#endif
50acee04
JS
623};
624
625
626class WXDLLIMPEXP_AUI wxDockInfo
627{
628public:
629 wxDockInfo()
630 {
631 dock_direction = 0;
632 dock_layer = 0;
633 dock_row = 0;
634 size = 0;
635 min_size = 0;
636 resizable = true;
637 fixed = false;
638 toolbar = false;
639 }
640
06d4c4d6 641#ifndef SWIG
50acee04
JS
642 wxDockInfo(const wxDockInfo& c)
643 {
644 dock_direction = c.dock_direction;
645 dock_layer = c.dock_layer;
646 dock_row = c.dock_row;
647 size = c.size;
648 min_size = c.min_size;
649 resizable = c.resizable;
650 fixed = c.fixed;
651 toolbar = c.toolbar;
652 panes = c.panes;
653 rect = c.rect;
654 }
655
656 wxDockInfo& operator=(const wxDockInfo& c)
657 {
658 dock_direction = c.dock_direction;
659 dock_layer = c.dock_layer;
660 dock_row = c.dock_row;
661 size = c.size;
662 min_size = c.min_size;
663 resizable = c.resizable;
664 fixed = c.fixed;
665 toolbar = c.toolbar;
666 panes = c.panes;
667 rect = c.rect;
668 return *this;
669 }
06d4c4d6 670#endif // SWIG
50acee04
JS
671
672 bool IsOk() const { return (dock_direction != 0) ? true : false; }
673 bool IsHorizontal() const { return (dock_direction == wxAUI_DOCK_TOP ||
674 dock_direction == wxAUI_DOCK_BOTTOM) ? true:false; }
675 bool IsVertical() const { return (dock_direction == wxAUI_DOCK_LEFT ||
676 dock_direction == wxAUI_DOCK_RIGHT ||
677 dock_direction == wxAUI_DOCK_CENTER) ? true:false; }
678public:
679 wxPaneInfoPtrArray panes; // array of panes
680 wxRect rect; // current rectangle
681 int dock_direction; // dock direction (top, bottom, left, right, center)
682 int dock_layer; // layer number (0 = innermost layer)
683 int dock_row; // row number on the docking bar (0 = first row)
684 int size; // size of the dock
685 int min_size; // minimum size of a dock (0 if there is no min)
686 bool resizable; // flag indicating whether the dock is resizable
687 bool toolbar; // flag indicating dock contains only toolbars
688 bool fixed; // flag indicating that the dock operates on
689 // absolute coordinates as opposed to proportional
690};
691
692
693class WXDLLIMPEXP_AUI wxDockUIPart
694{
695public:
696 enum
697 {
698 typeCaption,
699 typeGripper,
700 typeDock,
701 typeDockSizer,
702 typePane,
703 typePaneSizer,
704 typeBackground,
705 typePaneBorder,
55193d61 706 typePaneButton
50acee04
JS
707 };
708
709 int type; // ui part type (see enum above)
710 int orientation; // orientation (either wxHORIZONTAL or wxVERTICAL)
711 wxDockInfo* dock; // which dock the item is associated with
712 wxPaneInfo* pane; // which pane the item is associated with
713 wxPaneButton* button; // which pane button the item is associated with
714 wxSizer* cont_sizer; // the part's containing sizer
715 wxSizerItem* sizer_item; // the sizer item of the part
716 wxRect rect; // client coord rectangle of the part itself
717};
718
719
720class WXDLLIMPEXP_AUI wxPaneButton
721{
722public:
723 int button_id; // id of the button (e.g. buttonClose)
724};
725
726
727
06d4c4d6 728#ifndef SWIG
50acee04
JS
729// wx event machinery
730
50acee04 731BEGIN_DECLARE_EVENT_TYPES()
06d4c4d6
RD
732 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANEBUTTON, 0)
733 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANECLOSE, 0)
673727f3 734 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_RENDER, 0)
50acee04
JS
735END_DECLARE_EVENT_TYPES()
736
737typedef void (wxEvtHandler::*wxFrameManagerEventFunction)(wxFrameManagerEvent&);
738
739#define wxFrameManagerEventHandler(func) \
740 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxFrameManagerEventFunction, &func)
741
742#define EVT_AUI_PANEBUTTON(func) \
743 wx__DECLARE_EVT0(wxEVT_AUI_PANEBUTTON, wxFrameManagerEventHandler(func))
58754643
BW
744#define EVT_AUI_PANECLOSE(func) \
745 wx__DECLARE_EVT0(wxEVT_AUI_PANECLOSE, wxFrameManagerEventHandler(func))
673727f3
BW
746#define EVT_AUI_RENDER(func) \
747 wx__DECLARE_EVT0(wxEVT_AUI_RENDER, wxFrameManagerEventHandler(func))
58754643 748
06d4c4d6
RD
749#else
750
751%constant wxEventType wxEVT_AUI_PANEBUTTON;
752%constant wxEventType wxEVT_AUI_PANECLOSE;
673727f3 753%constant wxEventType wxEVT_AUI_RENDER;
06d4c4d6
RD
754
755%pythoncode {
756 EVT_AUI_PANEBUTTON = wx.PyEventBinder( wxEVT_AUI_PANEBUTTON )
757 EVT_AUI_PANECLOSE = wx.PyEventBinder( wxEVT_AUI_PANECLOSE )
673727f3 758 EVT_AUI_RENDER = wx.PyEventBinder( wxEVT_AUI_RENDER )
06d4c4d6
RD
759}
760#endif // SWIG
50acee04
JS
761
762#endif // wxUSE_AUI
763#endif //_WX_FRAMEMANAGER_H_
764