]> git.saurik.com Git - wxWidgets.git/blame - include/wx/aui/framemanager.h
Converted wxGTK's basic DC classes to new DC code
[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
a3a5df9d 29enum wxAuiManagerDock
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
a3a5df9d 40enum wxAuiManagerOption
50acee04 41{
cf6fec73
BW
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_VENETIAN_BLINDS_HINT = 1 << 4,
47 wxAUI_MGR_RECTANGLE_HINT = 1 << 5,
48 wxAUI_MGR_HINT_FADE = 1 << 6,
49 wxAUI_MGR_NO_VENETIAN_BLINDS_FADE = 1 << 7,
50acee04
JS
50
51 wxAUI_MGR_DEFAULT = wxAUI_MGR_ALLOW_FLOATING |
52 wxAUI_MGR_TRANSPARENT_HINT |
cf6fec73
BW
53 wxAUI_MGR_HINT_FADE |
54 wxAUI_MGR_NO_VENETIAN_BLINDS_FADE
50acee04
JS
55};
56
cf6fec73 57
a3a5df9d 58enum wxAuiPaneDockArtSetting
50acee04 59{
254a3429
BW
60 wxAUI_DOCKART_SASH_SIZE = 0,
61 wxAUI_DOCKART_CAPTION_SIZE = 1,
62 wxAUI_DOCKART_GRIPPER_SIZE = 2,
63 wxAUI_DOCKART_PANE_BORDER_SIZE = 3,
64 wxAUI_DOCKART_PANE_BUTTON_SIZE = 4,
65 wxAUI_DOCKART_BACKGROUND_COLOUR = 5,
66 wxAUI_DOCKART_SASH_COLOUR = 6,
67 wxAUI_DOCKART_ACTIVE_CAPTION_COLOUR = 7,
68 wxAUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8,
69 wxAUI_DOCKART_INACTIVE_CAPTION_COLOUR = 9,
70 wxAUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10,
71 wxAUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR = 11,
72 wxAUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR = 12,
73 wxAUI_DOCKART_BORDER_COLOUR = 13,
74 wxAUI_DOCKART_GRIPPER_COLOUR = 14,
75 wxAUI_DOCKART_CAPTION_FONT = 15,
76 wxAUI_DOCKART_GRADIENT_TYPE = 16
50acee04
JS
77};
78
a3a5df9d 79enum wxAuiPaneDockArtGradients
50acee04
JS
80{
81 wxAUI_GRADIENT_NONE = 0,
82 wxAUI_GRADIENT_VERTICAL = 1,
83 wxAUI_GRADIENT_HORIZONTAL = 2
84};
85
a3a5df9d 86enum wxAuiPaneButtonState
50acee04 87{
4953f8cf
BW
88 wxAUI_BUTTON_STATE_NORMAL = 0,
89 wxAUI_BUTTON_STATE_HOVER = 1 << 1,
90 wxAUI_BUTTON_STATE_PRESSED = 1 << 2,
91 wxAUI_BUTTON_STATE_DISABLED = 1 << 3,
0a5bb138
BW
92 wxAUI_BUTTON_STATE_HIDDEN = 1 << 4,
93 wxAUI_BUTTON_STATE_CHECKED = 1 << 5
4953f8cf
BW
94};
95
96enum wxAuiButtonId
97{
98 wxAUI_BUTTON_CLOSE = 101,
37106ab2 99 wxAUI_BUTTON_MAXIMIZE_RESTORE = 102,
4953f8cf
BW
100 wxAUI_BUTTON_MINIMIZE = 103,
101 wxAUI_BUTTON_PIN = 104,
102 wxAUI_BUTTON_OPTIONS = 105,
01372b8f
BW
103 wxAUI_BUTTON_WINDOWLIST = 106,
104 wxAUI_BUTTON_LEFT = 107,
105 wxAUI_BUTTON_RIGHT = 108,
106 wxAUI_BUTTON_UP = 109,
107 wxAUI_BUTTON_DOWN = 110,
4953f8cf
BW
108 wxAUI_BUTTON_CUSTOM1 = 201,
109 wxAUI_BUTTON_CUSTOM2 = 202,
110 wxAUI_BUTTON_CUSTOM3 = 203
50acee04
JS
111};
112
a3a5df9d 113enum wxAuiPaneInsertLevel
50acee04
JS
114{
115 wxAUI_INSERT_PANE = 0,
116 wxAUI_INSERT_ROW = 1,
117 wxAUI_INSERT_DOCK = 2
118};
119
120
121
4953f8cf 122
50acee04 123// forwards and array declarations
a3a5df9d
BW
124class wxAuiDockUIPart;
125class wxAuiPaneButton;
126class wxAuiPaneInfo;
127class wxAuiDockInfo;
128class wxAuiDockArt;
129class wxAuiManagerEvent;
50acee04 130
06d4c4d6 131#ifndef SWIG
a3a5df9d
BW
132WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiDockInfo, wxAuiDockInfoArray, WXDLLIMPEXP_AUI);
133WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiDockUIPart, wxAuiDockUIPartArray, WXDLLIMPEXP_AUI);
134WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiPaneButton, wxAuiPaneButtonArray, WXDLLIMPEXP_AUI);
135WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiPaneInfo, wxAuiPaneInfoArray, WXDLLIMPEXP_AUI);
136WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxAuiPaneInfo*, wxAuiPaneInfoPtrArray, class WXDLLIMPEXP_AUI);
137WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxAuiDockInfo*, wxAuiDockInfoPtrArray, class WXDLLIMPEXP_AUI);
06d4c4d6 138#endif // SWIG
50acee04 139
a3a5df9d
BW
140extern WXDLLIMPEXP_AUI wxAuiDockInfo wxAuiNullDockInfo;
141extern WXDLLIMPEXP_AUI wxAuiPaneInfo wxAuiNullPaneInfo;
50acee04
JS
142
143
144
a3a5df9d 145class WXDLLIMPEXP_AUI wxAuiPaneInfo
50acee04
JS
146{
147public:
148
a3a5df9d 149 wxAuiPaneInfo()
50acee04
JS
150 {
151 window = NULL;
152 frame = NULL;
153 state = 0;
154 dock_direction = wxAUI_DOCK_LEFT;
155 dock_layer = 0;
156 dock_row = 0;
157 dock_pos = 0;
158 floating_pos = wxDefaultPosition;
159 floating_size = wxDefaultSize;
160 best_size = wxDefaultSize;
161 min_size = wxDefaultSize;
162 max_size = wxDefaultSize;
163 dock_proportion = 0;
be66f18e 164
50acee04
JS
165 DefaultPane();
166 }
167
a3a5df9d 168 ~wxAuiPaneInfo() {}
858a3a7a 169
06d4c4d6 170#ifndef SWIG
a3a5df9d 171 wxAuiPaneInfo(const wxAuiPaneInfo& c)
50acee04
JS
172 {
173 name = c.name;
174 caption = c.caption;
175 window = c.window;
176 frame = c.frame;
177 state = c.state;
178 dock_direction = c.dock_direction;
179 dock_layer = c.dock_layer;
180 dock_row = c.dock_row;
181 dock_pos = c.dock_pos;
182 best_size = c.best_size;
183 min_size = c.min_size;
184 max_size = c.max_size;
185 floating_pos = c.floating_pos;
186 floating_size = c.floating_size;
187 dock_proportion = c.dock_proportion;
188 buttons = c.buttons;
189 rect = c.rect;
190 }
191
a3a5df9d 192 wxAuiPaneInfo& operator=(const wxAuiPaneInfo& c)
50acee04
JS
193 {
194 name = c.name;
195 caption = c.caption;
196 window = c.window;
197 frame = c.frame;
198 state = c.state;
199 dock_direction = c.dock_direction;
200 dock_layer = c.dock_layer;
201 dock_row = c.dock_row;
202 dock_pos = c.dock_pos;
203 best_size = c.best_size;
204 min_size = c.min_size;
205 max_size = c.max_size;
206 floating_pos = c.floating_pos;
207 floating_size = c.floating_size;
208 dock_proportion = c.dock_proportion;
209 buttons = c.buttons;
210 rect = c.rect;
211 return *this;
212 }
06d4c4d6 213#endif // SWIG
75c8d68f
AB
214
215 // Write the safe parts of a newly loaded PaneInfo structure "source" into "this"
216 // used on loading perspectives etc.
a3a5df9d 217 void SafeSet(wxAuiPaneInfo source)
75c8d68f
AB
218 {
219 // note source is not passed by reference so we can overwrite, to keep the
220 // unsafe bits of "dest"
221 source.window = window;
222 source.frame = frame;
223 source.buttons = buttons;
224 // now assign
225 *this = source;
226 }
227
cedd7b22 228 bool IsOk() const { return window != NULL; }
50acee04
JS
229 bool IsFixed() const { return !HasFlag(optionResizable); }
230 bool IsResizable() const { return HasFlag(optionResizable); }
231 bool IsShown() const { return !HasFlag(optionHidden); }
232 bool IsFloating() const { return HasFlag(optionFloating); }
233 bool IsDocked() const { return !HasFlag(optionFloating); }
234 bool IsToolbar() const { return HasFlag(optionToolbar); }
235 bool IsTopDockable() const { return HasFlag(optionTopDockable); }
236 bool IsBottomDockable() const { return HasFlag(optionBottomDockable); }
237 bool IsLeftDockable() const { return HasFlag(optionLeftDockable); }
238 bool IsRightDockable() const { return HasFlag(optionRightDockable); }
239 bool IsFloatable() const { return HasFlag(optionFloatable); }
240 bool IsMovable() const { return HasFlag(optionMovable); }
fa96a36e 241 bool IsDestroyOnClose() const { return HasFlag(optionDestroyOnClose); }
37106ab2 242 bool IsMaximized() const { return HasFlag(optionMaximized); }
50acee04
JS
243 bool HasCaption() const { return HasFlag(optionCaption); }
244 bool HasGripper() const { return HasFlag(optionGripper); }
245 bool HasBorder() const { return HasFlag(optionPaneBorder); }
246 bool HasCloseButton() const { return HasFlag(buttonClose); }
247 bool HasMaximizeButton() const { return HasFlag(buttonMaximize); }
248 bool HasMinimizeButton() const { return HasFlag(buttonMinimize); }
249 bool HasPinButton() const { return HasFlag(buttonPin); }
250 bool HasGripperTop() const { return HasFlag(optionGripperTop); }
be66f18e 251
06d4c4d6 252#ifdef SWIG
a3a5df9d 253 %typemap(out) wxAuiPaneInfo& { $result = $self; Py_INCREF($result); }
06d4c4d6 254#endif
a3a5df9d
BW
255 wxAuiPaneInfo& Window(wxWindow* w) { window = w; return *this; }
256 wxAuiPaneInfo& Name(const wxString& n) { name = n; return *this; }
257 wxAuiPaneInfo& Caption(const wxString& c) { caption = c; return *this; }
258 wxAuiPaneInfo& Left() { dock_direction = wxAUI_DOCK_LEFT; return *this; }
259 wxAuiPaneInfo& Right() { dock_direction = wxAUI_DOCK_RIGHT; return *this; }
260 wxAuiPaneInfo& Top() { dock_direction = wxAUI_DOCK_TOP; return *this; }
261 wxAuiPaneInfo& Bottom() { dock_direction = wxAUI_DOCK_BOTTOM; return *this; }
262 wxAuiPaneInfo& Center() { dock_direction = wxAUI_DOCK_CENTER; return *this; }
263 wxAuiPaneInfo& Centre() { dock_direction = wxAUI_DOCK_CENTRE; return *this; }
264 wxAuiPaneInfo& Direction(int direction) { dock_direction = direction; return *this; }
265 wxAuiPaneInfo& Layer(int layer) { dock_layer = layer; return *this; }
266 wxAuiPaneInfo& Row(int row) { dock_row = row; return *this; }
267 wxAuiPaneInfo& Position(int pos) { dock_pos = pos; return *this; }
268 wxAuiPaneInfo& BestSize(const wxSize& size) { best_size = size; return *this; }
269 wxAuiPaneInfo& MinSize(const wxSize& size) { min_size = size; return *this; }
270 wxAuiPaneInfo& MaxSize(const wxSize& size) { max_size = size; return *this; }
271 wxAuiPaneInfo& BestSize(int x, int y) { best_size.Set(x,y); return *this; }
272 wxAuiPaneInfo& MinSize(int x, int y) { min_size.Set(x,y); return *this; }
273 wxAuiPaneInfo& MaxSize(int x, int y) { max_size.Set(x,y); return *this; }
274 wxAuiPaneInfo& FloatingPosition(const wxPoint& pos) { floating_pos = pos; return *this; }
275 wxAuiPaneInfo& FloatingPosition(int x, int y) { floating_pos.x = x; floating_pos.y = y; return *this; }
276 wxAuiPaneInfo& FloatingSize(const wxSize& size) { floating_size = size; return *this; }
277 wxAuiPaneInfo& FloatingSize(int x, int y) { floating_size.Set(x,y); return *this; }
278 wxAuiPaneInfo& Fixed() { return SetFlag(optionResizable, false); }
279 wxAuiPaneInfo& Resizable(bool resizable = true) { return SetFlag(optionResizable, resizable); }
280 wxAuiPaneInfo& Dock() { return SetFlag(optionFloating, false); }
281 wxAuiPaneInfo& Float() { return SetFlag(optionFloating, true); }
282 wxAuiPaneInfo& Hide() { return SetFlag(optionHidden, true); }
283 wxAuiPaneInfo& Show(bool show = true) { return SetFlag(optionHidden, !show); }
284 wxAuiPaneInfo& CaptionVisible(bool visible = true) { return SetFlag(optionCaption, visible); }
285 wxAuiPaneInfo& Maximize() { return SetFlag(optionMaximized, true); }
286 wxAuiPaneInfo& Restore() { return SetFlag(optionMaximized, false); }
287 wxAuiPaneInfo& PaneBorder(bool visible = true) { return SetFlag(optionPaneBorder, visible); }
288 wxAuiPaneInfo& Gripper(bool visible = true) { return SetFlag(optionGripper, visible); }
289 wxAuiPaneInfo& GripperTop(bool attop = true) { return SetFlag(optionGripperTop, attop); }
290 wxAuiPaneInfo& CloseButton(bool visible = true) { return SetFlag(buttonClose, visible); }
291 wxAuiPaneInfo& MaximizeButton(bool visible = true) { return SetFlag(buttonMaximize, visible); }
292 wxAuiPaneInfo& MinimizeButton(bool visible = true) { return SetFlag(buttonMinimize, visible); }
293 wxAuiPaneInfo& PinButton(bool visible = true) { return SetFlag(buttonPin, visible); }
294 wxAuiPaneInfo& DestroyOnClose(bool b = true) { return SetFlag(optionDestroyOnClose, b); }
295 wxAuiPaneInfo& TopDockable(bool b = true) { return SetFlag(optionTopDockable, b); }
296 wxAuiPaneInfo& BottomDockable(bool b = true) { return SetFlag(optionBottomDockable, b); }
297 wxAuiPaneInfo& LeftDockable(bool b = true) { return SetFlag(optionLeftDockable, b); }
298 wxAuiPaneInfo& RightDockable(bool b = true) { return SetFlag(optionRightDockable, b); }
299 wxAuiPaneInfo& Floatable(bool b = true) { return SetFlag(optionFloatable, b); }
300 wxAuiPaneInfo& Movable(bool b = true) { return SetFlag(optionMovable, b); }
301
a3a5df9d 302 wxAuiPaneInfo& Dockable(bool b = true)
50acee04
JS
303 {
304 return TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b);
305 }
306
a3a5df9d 307 wxAuiPaneInfo& DefaultPane()
50acee04
JS
308 {
309 state |= optionTopDockable | optionBottomDockable |
310 optionLeftDockable | optionRightDockable |
311 optionFloatable | optionMovable | optionResizable |
312 optionCaption | optionPaneBorder | buttonClose;
313 return *this;
314 }
be66f18e 315
a3a5df9d
BW
316 wxAuiPaneInfo& CentrePane() { return CenterPane(); }
317 wxAuiPaneInfo& CenterPane()
50acee04
JS
318 {
319 state = 0;
320 return Center().PaneBorder().Resizable();
321 }
be66f18e 322
a3a5df9d 323 wxAuiPaneInfo& ToolbarPane()
50acee04
JS
324 {
325 DefaultPane();
326 state |= (optionToolbar | optionGripper);
327 state &= ~(optionResizable | optionCaption);
328 if (dock_layer == 0)
329 dock_layer = 10;
330 return *this;
331 }
332
a3a5df9d 333 wxAuiPaneInfo& SetFlag(unsigned int flag, bool option_state)
50acee04
JS
334 {
335 if (option_state)
336 state |= flag;
cedd7b22 337 else
50acee04
JS
338 state &= ~flag;
339 return *this;
340 }
be66f18e 341
50acee04
JS
342 bool HasFlag(unsigned int flag) const
343 {
cedd7b22 344 return (state & flag) != 0;
50acee04
JS
345 }
346
06d4c4d6 347#ifdef SWIG
a3a5df9d 348 %typemap(out) wxAuiPaneInfo& ;
06d4c4d6 349#endif
858a3a7a 350
50acee04
JS
351public:
352
9f41bf0e
RD
353 // NOTE: You can add and subtract flags from this list,
354 // but do not change the values of the flags, because
858a3a7a 355 // they are stored in a binary integer format in the
9f41bf0e
RD
356 // perspective string. If you really need to change the
357 // values around, you'll have to ensure backwards-compatibility
358 // in the perspective loading code.
a3a5df9d 359 enum wxAuiPaneState
50acee04
JS
360 {
361 optionFloating = 1 << 0,
362 optionHidden = 1 << 1,
363 optionLeftDockable = 1 << 2,
364 optionRightDockable = 1 << 3,
365 optionTopDockable = 1 << 4,
366 optionBottomDockable = 1 << 5,
367 optionFloatable = 1 << 6,
368 optionMovable = 1 << 7,
369 optionResizable = 1 << 8,
370 optionPaneBorder = 1 << 9,
371 optionCaption = 1 << 10,
372 optionGripper = 1 << 11,
373 optionDestroyOnClose = 1 << 12,
374 optionToolbar = 1 << 13,
375 optionActive = 1 << 14,
be66f18e 376 optionGripperTop = 1 << 15,
37106ab2 377 optionMaximized = 1 << 16,
8d0634ab 378
1dc6ec2c
BW
379 buttonClose = 1 << 21,
380 buttonMaximize = 1 << 22,
381 buttonMinimize = 1 << 23,
382 buttonPin = 1 << 24,
858a3a7a 383
8d0634ab
BW
384 buttonCustom1 = 1 << 26,
385 buttonCustom2 = 1 << 27,
386 buttonCustom3 = 1 << 28,
858a3a7a 387
8d0634ab 388 savedHiddenState = 1 << 30, // used internally
50acee04
JS
389 actionPane = 1 << 31 // used internally
390 };
391
392public:
393 wxString name; // name of the pane
394 wxString caption; // caption displayed on the window
395
396 wxWindow* window; // window that is in this pane
50f3c41d 397 wxFrame* frame; // floating frame window that holds the pane
50acee04
JS
398 unsigned int state; // a combination of wxPaneState values
399
400 int dock_direction; // dock direction (top, bottom, left, right, center)
401 int dock_layer; // layer number (0 = innermost layer)
402 int dock_row; // row number on the docking bar (0 = first row)
403 int dock_pos; // position inside the row (0 = first position)
404
405 wxSize best_size; // size that the layout engine will prefer
406 wxSize min_size; // minimum size the pane window can tolerate
407 wxSize max_size; // maximum size the pane window can tolerate
408
409 wxPoint floating_pos; // position while floating
410 wxSize floating_size; // size while floating
411 int dock_proportion; // proportion while docked
412
a3a5df9d 413 wxAuiPaneButtonArray buttons; // buttons on the pane
50acee04
JS
414
415 wxRect rect; // current rectangle (populated by wxAUI)
416};
417
418
419
b5dbe15d 420class WXDLLIMPEXP_FWD_AUI wxAuiFloatingFrame;
50acee04 421
a3a5df9d 422class WXDLLIMPEXP_AUI wxAuiManager : public wxEvtHandler
50acee04 423{
00c1c94c 424friend class wxAuiFloatingFrame;
50acee04
JS
425
426public:
427
a3a5df9d 428 wxAuiManager(wxWindow* managed_wnd = NULL,
50acee04 429 unsigned int flags = wxAUI_MGR_DEFAULT);
a3a5df9d 430 virtual ~wxAuiManager();
50acee04 431 void UnInit();
be66f18e 432
50acee04
JS
433 void SetFlags(unsigned int flags);
434 unsigned int GetFlags() const;
be66f18e 435
461125ea
BW
436 void SetManagedWindow(wxWindow* managed_wnd);
437 wxWindow* GetManagedWindow() const;
be66f18e 438
4dc79cfb
BW
439 static wxAuiManager* GetManager(wxWindow* window);
440
af672b5a 441#ifdef SWIG
a3a5df9d 442 %disownarg( wxAuiDockArt* art_provider );
af672b5a 443#endif
a3a5df9d
BW
444 void SetArtProvider(wxAuiDockArt* art_provider);
445 wxAuiDockArt* GetArtProvider() const;
50acee04 446
a3a5df9d
BW
447 wxAuiPaneInfo& GetPane(wxWindow* window);
448 wxAuiPaneInfo& GetPane(const wxString& name);
449 wxAuiPaneInfoArray& GetAllPanes();
50acee04
JS
450
451 bool AddPane(wxWindow* window,
a3a5df9d 452 const wxAuiPaneInfo& pane_info);
858a3a7a 453
0603bb28 454 bool AddPane(wxWindow* window,
a3a5df9d 455 const wxAuiPaneInfo& pane_info,
0603bb28 456 const wxPoint& drop_pos);
be66f18e 457
50acee04
JS
458 bool AddPane(wxWindow* window,
459 int direction = wxLEFT,
460 const wxString& caption = wxEmptyString);
be66f18e 461
50acee04 462 bool InsertPane(wxWindow* window,
a3a5df9d 463 const wxAuiPaneInfo& insert_location,
50acee04 464 int insert_level = wxAUI_INSERT_PANE);
be66f18e 465
50acee04 466 bool DetachPane(wxWindow* window);
858a3a7a 467
a6b7a521 468 void Update();
50acee04 469
a3a5df9d
BW
470 wxString SavePaneInfo(wxAuiPaneInfo& pane);
471 void LoadPaneInfo(wxString pane_part, wxAuiPaneInfo &pane);
50acee04 472 wxString SavePerspective();
a6b7a521 473 bool LoadPerspective(const wxString& perspective, bool update = true);
be66f18e 474
a6b7a521
VZ
475 void SetDockSizeConstraint(double width_pct, double height_pct);
476 void GetDockSizeConstraint(double* width_pct, double* height_pct) const;
858a3a7a 477
a6b7a521
VZ
478 void ClosePane(wxAuiPaneInfo& pane_info);
479 void MaximizePane(wxAuiPaneInfo& pane_info);
480 void RestorePane(wxAuiPaneInfo& pane_info);
481 void RestoreMaximizedPane();
50acee04 482
0603bb28 483public:
cf37c9a9 484
00c1c94c 485 virtual wxAuiFloatingFrame* CreateFloatingFrame(wxWindow* parent, const wxAuiPaneInfo& p);
858a3a7a 486 virtual bool CanDockPanel(const wxAuiPaneInfo & p);
0603bb28 487
cf37c9a9
BW
488 void StartPaneDrag(
489 wxWindow* pane_window,
490 const wxPoint& offset);
491
492 wxRect CalculateHintRect(
493 wxWindow* pane_window,
494 const wxPoint& pt,
495 const wxPoint& offset);
858a3a7a 496
cf37c9a9
BW
497 void DrawHintRect(
498 wxWindow* pane_window,
499 const wxPoint& pt,
500 const wxPoint& offset);
858a3a7a 501
0603bb28
BW
502 virtual void ShowHint(const wxRect& rect);
503 virtual void HideHint();
504
461125ea
BW
505public:
506
507 // deprecated -- please use SetManagedWindow() and
508 // and GetManagedWindow() instead
858a3a7a 509
461125ea
BW
510 wxDEPRECATED( void SetFrame(wxFrame* frame) );
511 wxDEPRECATED( wxFrame* GetFrame() const );
858a3a7a 512
e4542fa6 513protected:
50acee04 514
cf6fec73 515 void UpdateHintWindowConfig();
858a3a7a 516
50acee04
JS
517 void DoFrameLayout();
518
519 void LayoutAddPane(wxSizer* container,
a3a5df9d
BW
520 wxAuiDockInfo& dock,
521 wxAuiPaneInfo& pane,
522 wxAuiDockUIPartArray& uiparts,
50acee04
JS
523 bool spacer_only);
524
525 void LayoutAddDock(wxSizer* container,
a3a5df9d
BW
526 wxAuiDockInfo& dock,
527 wxAuiDockUIPartArray& uiparts,
50acee04
JS
528 bool spacer_only);
529
a3a5df9d
BW
530 wxSizer* LayoutAll(wxAuiPaneInfoArray& panes,
531 wxAuiDockInfoArray& docks,
532 wxAuiDockUIPartArray& uiparts,
50acee04
JS
533 bool spacer_only = false);
534
a3a5df9d
BW
535 virtual bool ProcessDockResult(wxAuiPaneInfo& target,
536 const wxAuiPaneInfo& new_pos);
0d02dd54 537
a3a5df9d
BW
538 bool DoDrop(wxAuiDockInfoArray& docks,
539 wxAuiPaneInfoArray& panes,
540 wxAuiPaneInfo& drop,
50acee04
JS
541 const wxPoint& pt,
542 const wxPoint& action_offset = wxPoint(0,0));
543
a3a5df9d
BW
544 wxAuiDockUIPart* HitTest(int x, int y);
545 wxAuiDockUIPart* GetPanePart(wxWindow* pane);
546 int GetDockPixelOffset(wxAuiPaneInfo& test);
50acee04 547 void OnFloatingPaneMoveStart(wxWindow* window);
322c5ec4
RR
548 void OnFloatingPaneMoving(wxWindow* window, wxDirection dir );
549 void OnFloatingPaneMoved(wxWindow* window, wxDirection dir);
50acee04 550 void OnFloatingPaneActivated(wxWindow* window);
58754643 551 void OnFloatingPaneClosed(wxWindow* window, wxCloseEvent& evt);
50acee04
JS
552 void OnFloatingPaneResized(wxWindow* window, const wxSize& size);
553 void Render(wxDC* dc);
554 void Repaint(wxDC* dc = NULL);
a3a5df9d
BW
555 void ProcessMgrEvent(wxAuiManagerEvent& event);
556 void UpdateButtonOnScreen(wxAuiDockUIPart* button_ui_part,
50acee04 557 const wxMouseEvent& event);
a3a5df9d 558 void GetPanePositionsAndSizes(wxAuiDockInfo& dock,
50acee04
JS
559 wxArrayInt& positions,
560 wxArrayInt& sizes);
0603bb28 561
50acee04 562
673727f3
BW
563public:
564
565 // public events (which can be invoked externally)
a3a5df9d
BW
566 void OnRender(wxAuiManagerEvent& evt);
567 void OnPaneButton(wxAuiManagerEvent& evt);
673727f3 568
e4542fa6 569protected:
50acee04 570
673727f3
BW
571 // protected events
572 void OnPaint(wxPaintEvent& evt);
573 void OnEraseBackground(wxEraseEvent& evt);
574 void OnSize(wxSizeEvent& evt);
575 void OnSetCursor(wxSetCursorEvent& evt);
576 void OnLeftDown(wxMouseEvent& evt);
577 void OnLeftUp(wxMouseEvent& evt);
578 void OnMotion(wxMouseEvent& evt);
579 void OnLeaveWindow(wxMouseEvent& evt);
580 void OnChildFocus(wxChildFocusEvent& evt);
581 void OnHintFadeTimer(wxTimerEvent& evt);
4dc79cfb 582 void OnFindManager(wxAuiManagerEvent& evt);
50acee04 583
e4542fa6 584protected:
50acee04
JS
585
586 enum
587 {
588 actionNone = 0,
589 actionResize,
590 actionClickButton,
591 actionClickCaption,
592 actionDragToolbarPane,
593 actionDragFloatingPane
594 };
595
e4542fa6 596protected:
50acee04 597
a189504e 598 wxWindow* m_frame; // the window being managed
a3a5df9d 599 wxAuiDockArt* m_art; // dock art object which does all drawing
50acee04
JS
600 unsigned int m_flags; // manager flags wxAUI_MGR_*
601
a3a5df9d
BW
602 wxAuiPaneInfoArray m_panes; // array of panes structures
603 wxAuiDockInfoArray m_docks; // array of docks structures
604 wxAuiDockUIPartArray m_uiparts; // array of UI parts (captions, buttons, etc)
50acee04
JS
605
606 int m_action; // current mouse action
607 wxPoint m_action_start; // position where the action click started
608 wxPoint m_action_offset; // offset from upper left of the item clicked
a3a5df9d 609 wxAuiDockUIPart* m_action_part; // ptr to the part the action happened to
50acee04
JS
610 wxWindow* m_action_window; // action frame or window (NULL if none)
611 wxRect m_action_hintrect; // hint rectangle for the action
c3008402 612 wxRect m_last_rect;
a3a5df9d 613 wxAuiDockUIPart* m_hover_button;// button uipart being hovered over
50acee04
JS
614 wxRect m_last_hint; // last hint rectangle
615 wxPoint m_last_mouse_move; // last mouse move position (see OnMotion)
a6b7a521
VZ
616 bool m_skipping;
617 bool m_has_maximized;
618
619 double m_dock_constraint_x; // 0.0 .. 1.0; max pct of window width a dock can consume
620 double m_dock_constraint_y; // 0.0 .. 1.0; max pct of window height a dock can consume
50acee04 621
50f3c41d
RD
622 wxFrame* m_hint_wnd; // transparent hint window, if supported by platform
623 wxTimer m_hint_fadetimer; // transparent fade timer
db847131 624 wxByte m_hint_fadeamt; // transparent fade amount
7a5b04a6 625 wxByte m_hint_fademax; // maximum value of hint fade
858a3a7a 626
1dc6ec2c 627 void* m_reserved;
be66f18e 628
06d4c4d6 629#ifndef SWIG
50acee04 630 DECLARE_EVENT_TABLE()
4dc79cfb 631 DECLARE_CLASS(wxAuiManager)
06d4c4d6 632#endif // SWIG
50acee04
JS
633};
634
635
636
637// event declarations/classes
638
a3a5df9d 639class WXDLLIMPEXP_AUI wxAuiManagerEvent : public wxEvent
50acee04
JS
640{
641public:
a3a5df9d 642 wxAuiManagerEvent(wxEventType type=wxEVT_NULL) : wxEvent(0, type)
50acee04 643 {
4dc79cfb 644 manager = NULL;
50acee04
JS
645 pane = NULL;
646 button = 0;
58754643
BW
647 veto_flag = false;
648 canveto_flag = true;
673727f3 649 dc = NULL;
50acee04 650 }
06d4c4d6 651#ifndef SWIG
a3a5df9d 652 wxAuiManagerEvent(const wxAuiManagerEvent& c) : wxEvent(c)
50acee04 653 {
4dc79cfb 654 manager = c.manager;
50acee04
JS
655 pane = c.pane;
656 button = c.button;
58754643
BW
657 veto_flag = c.veto_flag;
658 canveto_flag = c.canveto_flag;
673727f3 659 dc = c.dc;
50acee04 660 }
06d4c4d6 661#endif
a3a5df9d 662 wxEvent *Clone() const { return new wxAuiManagerEvent(*this); }
50acee04 663
4dc79cfb 664 void SetManager(wxAuiManager* mgr) { manager = mgr; }
a3a5df9d 665 void SetPane(wxAuiPaneInfo* p) { pane = p; }
50acee04 666 void SetButton(int b) { button = b; }
673727f3 667 void SetDC(wxDC* pdc) { dc = pdc; }
858a3a7a 668
4dc79cfb
BW
669 wxAuiManager* GetManager() const { return manager; }
670 wxAuiPaneInfo* GetPane() const { return pane; }
671 int GetButton() const { return button; }
672 wxDC* GetDC() const { return dc; }
858a3a7a 673
58754643
BW
674 void Veto(bool veto = true) { veto_flag = veto; }
675 bool GetVeto() const { return veto_flag; }
676 void SetCanVeto(bool can_veto) { canveto_flag = can_veto; }
677 bool CanVeto() const { return canveto_flag && veto_flag; }
858a3a7a 678
50acee04 679public:
4dc79cfb 680 wxAuiManager* manager;
a3a5df9d 681 wxAuiPaneInfo* pane;
50acee04 682 int button;
58754643
BW
683 bool veto_flag;
684 bool canveto_flag;
673727f3 685 wxDC* dc;
af672b5a
RD
686
687#ifndef SWIG
688private:
a3a5df9d 689 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxAuiManagerEvent)
af672b5a 690#endif
50acee04
JS
691};
692
693
a3a5df9d 694class WXDLLIMPEXP_AUI wxAuiDockInfo
50acee04
JS
695{
696public:
a3a5df9d 697 wxAuiDockInfo()
50acee04
JS
698 {
699 dock_direction = 0;
700 dock_layer = 0;
701 dock_row = 0;
702 size = 0;
703 min_size = 0;
704 resizable = true;
705 fixed = false;
706 toolbar = false;
1dc6ec2c 707 reserved1 = false;
50acee04
JS
708 }
709
06d4c4d6 710#ifndef SWIG
a3a5df9d 711 wxAuiDockInfo(const wxAuiDockInfo& c)
50acee04
JS
712 {
713 dock_direction = c.dock_direction;
714 dock_layer = c.dock_layer;
715 dock_row = c.dock_row;
716 size = c.size;
717 min_size = c.min_size;
718 resizable = c.resizable;
719 fixed = c.fixed;
720 toolbar = c.toolbar;
721 panes = c.panes;
722 rect = c.rect;
1dc6ec2c 723 reserved1 = c.reserved1;
50acee04
JS
724 }
725
a3a5df9d 726 wxAuiDockInfo& operator=(const wxAuiDockInfo& c)
50acee04
JS
727 {
728 dock_direction = c.dock_direction;
729 dock_layer = c.dock_layer;
730 dock_row = c.dock_row;
731 size = c.size;
732 min_size = c.min_size;
733 resizable = c.resizable;
734 fixed = c.fixed;
735 toolbar = c.toolbar;
736 panes = c.panes;
737 rect = c.rect;
1dc6ec2c 738 reserved1 = c.reserved1;
50acee04
JS
739 return *this;
740 }
06d4c4d6 741#endif // SWIG
50acee04 742
cedd7b22
PC
743 bool IsOk() const { return dock_direction != 0; }
744 bool IsHorizontal() const { return dock_direction == wxAUI_DOCK_TOP ||
745 dock_direction == wxAUI_DOCK_BOTTOM; }
746 bool IsVertical() const { return dock_direction == wxAUI_DOCK_LEFT ||
50acee04 747 dock_direction == wxAUI_DOCK_RIGHT ||
cedd7b22 748 dock_direction == wxAUI_DOCK_CENTER; }
50acee04 749public:
a3a5df9d 750 wxAuiPaneInfoPtrArray panes; // array of panes
50acee04
JS
751 wxRect rect; // current rectangle
752 int dock_direction; // dock direction (top, bottom, left, right, center)
753 int dock_layer; // layer number (0 = innermost layer)
754 int dock_row; // row number on the docking bar (0 = first row)
755 int size; // size of the dock
756 int min_size; // minimum size of a dock (0 if there is no min)
757 bool resizable; // flag indicating whether the dock is resizable
758 bool toolbar; // flag indicating dock contains only toolbars
759 bool fixed; // flag indicating that the dock operates on
760 // absolute coordinates as opposed to proportional
1dc6ec2c 761 bool reserved1;
50acee04
JS
762};
763
764
a3a5df9d 765class WXDLLIMPEXP_AUI wxAuiDockUIPart
50acee04
JS
766{
767public:
768 enum
769 {
770 typeCaption,
771 typeGripper,
772 typeDock,
773 typeDockSizer,
774 typePane,
775 typePaneSizer,
776 typeBackground,
777 typePaneBorder,
55193d61 778 typePaneButton
50acee04
JS
779 };
780
781 int type; // ui part type (see enum above)
782 int orientation; // orientation (either wxHORIZONTAL or wxVERTICAL)
a3a5df9d
BW
783 wxAuiDockInfo* dock; // which dock the item is associated with
784 wxAuiPaneInfo* pane; // which pane the item is associated with
785 wxAuiPaneButton* button; // which pane button the item is associated with
50acee04
JS
786 wxSizer* cont_sizer; // the part's containing sizer
787 wxSizerItem* sizer_item; // the sizer item of the part
788 wxRect rect; // client coord rectangle of the part itself
789};
790
791
a3a5df9d 792class WXDLLIMPEXP_AUI wxAuiPaneButton
50acee04
JS
793{
794public:
795 int button_id; // id of the button (e.g. buttonClose)
796};
797
798
799
06d4c4d6 800#ifndef SWIG
50acee04
JS
801// wx event machinery
802
50acee04 803BEGIN_DECLARE_EVENT_TYPES()
bc07ab17
RD
804 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANE_BUTTON, 0)
805 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANE_CLOSE, 0)
806 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANE_MAXIMIZE, 0)
807 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANE_RESTORE, 0)
673727f3 808 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_RENDER, 0)
bc07ab17 809 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_FIND_MANAGER, 0)
50acee04
JS
810END_DECLARE_EVENT_TYPES()
811
a3a5df9d 812typedef void (wxEvtHandler::*wxAuiManagerEventFunction)(wxAuiManagerEvent&);
50acee04 813
a3a5df9d
BW
814#define wxAuiManagerEventHandler(func) \
815 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxAuiManagerEventFunction, &func)
50acee04 816
bc07ab17
RD
817#define EVT_AUI_PANE_BUTTON(func) \
818 wx__DECLARE_EVT0(wxEVT_AUI_PANE_BUTTON, wxAuiManagerEventHandler(func))
819#define EVT_AUI_PANE_CLOSE(func) \
820 wx__DECLARE_EVT0(wxEVT_AUI_PANE_CLOSE, wxAuiManagerEventHandler(func))
821#define EVT_AUI_PANE_MAXIMIZE(func) \
822 wx__DECLARE_EVT0(wxEVT_AUI_PANE_MAXIMIZE, wxAuiManagerEventHandler(func))
823#define EVT_AUI_PANE_RESTORE(func) \
824 wx__DECLARE_EVT0(wxEVT_AUI_PANE_RESTORE, wxAuiManagerEventHandler(func))
673727f3 825#define EVT_AUI_RENDER(func) \
a3a5df9d 826 wx__DECLARE_EVT0(wxEVT_AUI_RENDER, wxAuiManagerEventHandler(func))
bc07ab17
RD
827#define EVT_AUI_FIND_MANAGER(func) \
828 wx__DECLARE_EVT0(wxEVT_AUI_FIND_MANAGER, wxAuiManagerEventHandler(func))
58754643 829
06d4c4d6
RD
830#else
831
bc07ab17
RD
832%constant wxEventType wxEVT_AUI_PANE_BUTTON;
833%constant wxEventType wxEVT_AUI_PANE_CLOSE;
834%constant wxEventType wxEVT_AUI_PANE_MAXIMIZE;
835%constant wxEventType wxEVT_AUI_PANE_RESTORE;
673727f3 836%constant wxEventType wxEVT_AUI_RENDER;
bc07ab17 837%constant wxEventType wxEVT_AUI_FIND_MANAGER;
06d4c4d6
RD
838
839%pythoncode {
bc07ab17
RD
840 EVT_AUI_PANE_BUTTON = wx.PyEventBinder( wxEVT_AUI_PANE_BUTTON )
841 EVT_AUI_PANE_CLOSE = wx.PyEventBinder( wxEVT_AUI_PANE_CLOSE )
842 EVT_AUI_PANE_MAXIMIZE = wx.PyEventBinder( wxEVT_AUI_PANE_MAXIMIZE )
843 EVT_AUI_PANE_RESTORE = wx.PyEventBinder( wxEVT_AUI_PANE_RESTORE )
673727f3 844 EVT_AUI_RENDER = wx.PyEventBinder( wxEVT_AUI_RENDER )
bc07ab17 845 EVT_AUI_FIND_MANAGER = wx.PyEventBinder( wxEVT_AUI_FIND_MANAGER )
06d4c4d6
RD
846}
847#endif // SWIG
50acee04
JS
848
849#endif // wxUSE_AUI
850#endif //_WX_FRAMEMANAGER_H_
851