///////////////////////////////////////////////////////////////////////////////
-// Name: framemanager.h
+// Name: wx/aui/framemanager.h
// Purpose: wxaui: wx advanced user interface - docking window manager
// Author: Benjamin I. Williams
// Modified by:
// Created: 2005-05-17
-// RCS-ID:
+// RCS-ID: $Id$
// Copyright: (C) Copyright 2005, Kirix Corporation, All Rights Reserved.
// Licence: wxWindows Library Licence, Version 3.1
///////////////////////////////////////////////////////////////////////////////
#if wxUSE_AUI
-enum WXDLLIMPEXP_AUI wxFrameManagerDock
+#include "wx/dynarray.h"
+#include "wx/gdicmn.h"
+#include "wx/window.h"
+#include "wx/timer.h"
+#include "wx/sizer.h"
+
+enum wxAuiManagerDock
{
wxAUI_DOCK_NONE = 0,
wxAUI_DOCK_TOP = 1,
wxAUI_DOCK_CENTRE = wxAUI_DOCK_CENTER
};
-enum WXDLLIMPEXP_AUI wxFrameManagerOption
+enum wxAuiManagerOption
{
- wxAUI_MGR_ALLOW_FLOATING = 1 << 0,
- wxAUI_MGR_ALLOW_ACTIVE_PANE = 1 << 1,
- wxAUI_MGR_TRANSPARENT_DRAG = 1 << 2,
- wxAUI_MGR_TRANSPARENT_HINT = 1 << 3,
- wxAUI_MGR_TRANSPARENT_HINT_FADE = 1 << 4,
+ wxAUI_MGR_ALLOW_FLOATING = 1 << 0,
+ wxAUI_MGR_ALLOW_ACTIVE_PANE = 1 << 1,
+ wxAUI_MGR_TRANSPARENT_DRAG = 1 << 2,
+ wxAUI_MGR_TRANSPARENT_HINT = 1 << 3,
+ wxAUI_MGR_VENETIAN_BLINDS_HINT = 1 << 4,
+ wxAUI_MGR_RECTANGLE_HINT = 1 << 5,
+ wxAUI_MGR_HINT_FADE = 1 << 6,
+ wxAUI_MGR_NO_VENETIAN_BLINDS_FADE = 1 << 7,
wxAUI_MGR_DEFAULT = wxAUI_MGR_ALLOW_FLOATING |
wxAUI_MGR_TRANSPARENT_HINT |
- wxAUI_MGR_TRANSPARENT_HINT_FADE
+ wxAUI_MGR_HINT_FADE |
+ wxAUI_MGR_NO_VENETIAN_BLINDS_FADE
};
-enum WXDLLIMPEXP_AUI wxPaneDockArtSetting
+
+enum wxAuiPaneDockArtSetting
{
- wxAUI_ART_SASH_SIZE = 0,
- wxAUI_ART_CAPTION_SIZE = 1,
- wxAUI_ART_GRIPPER_SIZE = 2,
- wxAUI_ART_PANE_BORDER_SIZE = 3,
- wxAUI_ART_PANE_BUTTON_SIZE = 4,
- wxAUI_ART_BACKGROUND_COLOUR = 5,
- wxAUI_ART_SASH_COLOUR = 6,
- wxAUI_ART_ACTIVE_CAPTION_COLOUR = 7,
- wxAUI_ART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8,
- wxAUI_ART_INACTIVE_CAPTION_COLOUR = 9,
- wxAUI_ART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10,
- wxAUI_ART_ACTIVE_CAPTION_TEXT_COLOUR = 11,
- wxAUI_ART_INACTIVE_CAPTION_TEXT_COLOUR = 12,
- wxAUI_ART_BORDER_COLOUR = 13,
- wxAUI_ART_GRIPPER_COLOUR = 14,
- wxAUI_ART_CAPTION_FONT = 15,
- wxAUI_ART_GRADIENT_TYPE = 16
+ wxAUI_DOCKART_SASH_SIZE = 0,
+ wxAUI_DOCKART_CAPTION_SIZE = 1,
+ wxAUI_DOCKART_GRIPPER_SIZE = 2,
+ wxAUI_DOCKART_PANE_BORDER_SIZE = 3,
+ wxAUI_DOCKART_PANE_BUTTON_SIZE = 4,
+ wxAUI_DOCKART_BACKGROUND_COLOUR = 5,
+ wxAUI_DOCKART_SASH_COLOUR = 6,
+ wxAUI_DOCKART_ACTIVE_CAPTION_COLOUR = 7,
+ wxAUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8,
+ wxAUI_DOCKART_INACTIVE_CAPTION_COLOUR = 9,
+ wxAUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10,
+ wxAUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR = 11,
+ wxAUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR = 12,
+ wxAUI_DOCKART_BORDER_COLOUR = 13,
+ wxAUI_DOCKART_GRIPPER_COLOUR = 14,
+ wxAUI_DOCKART_CAPTION_FONT = 15,
+ wxAUI_DOCKART_GRADIENT_TYPE = 16
};
-enum WXDLLIMPEXP_AUI wxPaneDockArtGradients
+enum wxAuiPaneDockArtGradients
{
wxAUI_GRADIENT_NONE = 0,
wxAUI_GRADIENT_VERTICAL = 1,
wxAUI_GRADIENT_HORIZONTAL = 2
};
-enum WXDLLIMPEXP_AUI wxPaneButtonState
+enum wxAuiPaneButtonState
+{
+ wxAUI_BUTTON_STATE_NORMAL = 0,
+ wxAUI_BUTTON_STATE_HOVER = 1 << 1,
+ wxAUI_BUTTON_STATE_PRESSED = 1 << 2,
+ wxAUI_BUTTON_STATE_DISABLED = 1 << 3,
+ wxAUI_BUTTON_STATE_HIDDEN = 1 << 4,
+ wxAUI_BUTTON_STATE_CHECKED = 1 << 5
+};
+
+enum wxAuiButtonId
{
- wxAUI_BUTTON_STATE_NORMAL = 0,
- wxAUI_BUTTON_STATE_HOVER = 1,
- wxAUI_BUTTON_STATE_PRESSED = 2
+ wxAUI_BUTTON_CLOSE = 101,
+ wxAUI_BUTTON_MAXIMIZE_RESTORE = 102,
+ wxAUI_BUTTON_MINIMIZE = 103,
+ wxAUI_BUTTON_PIN = 104,
+ wxAUI_BUTTON_OPTIONS = 105,
+ wxAUI_BUTTON_WINDOWLIST = 106,
+ wxAUI_BUTTON_LEFT = 107,
+ wxAUI_BUTTON_RIGHT = 108,
+ wxAUI_BUTTON_UP = 109,
+ wxAUI_BUTTON_DOWN = 110,
+ wxAUI_BUTTON_CUSTOM1 = 201,
+ wxAUI_BUTTON_CUSTOM2 = 202,
+ wxAUI_BUTTON_CUSTOM3 = 203
};
-enum WXDLLIMPEXP_AUI wxPaneInsertLevel
+enum wxAuiPaneInsertLevel
{
wxAUI_INSERT_PANE = 0,
wxAUI_INSERT_ROW = 1,
-// forwards and array declarations
-class wxDockUIPart;
-class wxPaneButton;
-class wxPaneInfo;
-class wxDockInfo;
-class wxDockArt;
-class wxFrameManagerEvent;
-WX_DECLARE_OBJARRAY(wxDockInfo, wxDockInfoArray);
-WX_DECLARE_OBJARRAY(wxDockUIPart, wxDockUIPartArray);
-WX_DECLARE_OBJARRAY(wxPaneButton, wxPaneButtonArray);
-WX_DECLARE_OBJARRAY(wxPaneInfo, wxPaneInfoArray);
-WX_DEFINE_ARRAY_PTR(wxPaneInfo*, wxPaneInfoPtrArray);
-WX_DEFINE_ARRAY_PTR(wxDockInfo*, wxDockInfoPtrArray);
+// forwards and array declarations
+class wxAuiDockUIPart;
+class wxAuiPaneButton;
+class wxAuiPaneInfo;
+class wxAuiDockInfo;
+class wxAuiDockArt;
+class wxAuiManagerEvent;
-extern wxDockInfo wxNullDockInfo;
-extern wxPaneInfo wxNullPaneInfo;
+#ifndef SWIG
+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiDockInfo, wxAuiDockInfoArray, WXDLLIMPEXP_AUI);
+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiDockUIPart, wxAuiDockUIPartArray, WXDLLIMPEXP_AUI);
+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiPaneButton, wxAuiPaneButtonArray, WXDLLIMPEXP_AUI);
+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiPaneInfo, wxAuiPaneInfoArray, WXDLLIMPEXP_AUI);
+WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxAuiPaneInfo*, wxAuiPaneInfoPtrArray, class WXDLLIMPEXP_AUI);
+WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxAuiDockInfo*, wxAuiDockInfoPtrArray, class WXDLLIMPEXP_AUI);
+#endif // SWIG
+extern WXDLLIMPEXP_AUI wxAuiDockInfo wxAuiNullDockInfo;
+extern WXDLLIMPEXP_AUI wxAuiPaneInfo wxAuiNullPaneInfo;
-class WXDLLIMPEXP_AUI wxPaneInfo
+class WXDLLIMPEXP_AUI wxAuiPaneInfo
{
public:
- wxPaneInfo()
+ wxAuiPaneInfo()
{
window = NULL;
frame = NULL;
min_size = wxDefaultSize;
max_size = wxDefaultSize;
dock_proportion = 0;
-
+
DefaultPane();
}
- wxPaneInfo(const wxPaneInfo& c)
+ ~wxAuiPaneInfo() {}
+
+#ifndef SWIG
+ wxAuiPaneInfo(const wxAuiPaneInfo& c)
{
name = c.name;
caption = c.caption;
rect = c.rect;
}
- wxPaneInfo& operator=(const wxPaneInfo& c)
+ wxAuiPaneInfo& operator=(const wxAuiPaneInfo& c)
{
name = c.name;
caption = c.caption;
rect = c.rect;
return *this;
}
+#endif // SWIG
- bool IsOk() const { return (window != NULL) ? true : false; }
+ // Write the safe parts of a newly loaded PaneInfo structure "source" into "this"
+ // used on loading perspectives etc.
+ void SafeSet(wxAuiPaneInfo source)
+ {
+ // note source is not passed by reference so we can overwrite, to keep the
+ // unsafe bits of "dest"
+ source.window = window;
+ source.frame = frame;
+ source.buttons = buttons;
+ // now assign
+ *this = source;
+ }
+
+ bool IsOk() const { return window != NULL; }
bool IsFixed() const { return !HasFlag(optionResizable); }
bool IsResizable() const { return HasFlag(optionResizable); }
bool IsShown() const { return !HasFlag(optionHidden); }
bool IsRightDockable() const { return HasFlag(optionRightDockable); }
bool IsFloatable() const { return HasFlag(optionFloatable); }
bool IsMovable() const { return HasFlag(optionMovable); }
+ bool IsDestroyOnClose() const { return HasFlag(optionDestroyOnClose); }
+ bool IsMaximized() const { return HasFlag(optionMaximized); }
bool HasCaption() const { return HasFlag(optionCaption); }
bool HasGripper() const { return HasFlag(optionGripper); }
bool HasBorder() const { return HasFlag(optionPaneBorder); }
bool HasMinimizeButton() const { return HasFlag(buttonMinimize); }
bool HasPinButton() const { return HasFlag(buttonPin); }
bool HasGripperTop() const { return HasFlag(optionGripperTop); }
-
- wxPaneInfo& Window(wxWindow* w) { window = w; return *this; }
- wxPaneInfo& Name(const wxString& n) { name = n; return *this; }
- wxPaneInfo& Caption(const wxString& c) { caption = c; return *this; }
- wxPaneInfo& Left() { dock_direction = wxAUI_DOCK_LEFT; return *this; }
- wxPaneInfo& Right() { dock_direction = wxAUI_DOCK_RIGHT; return *this; }
- wxPaneInfo& Top() { dock_direction = wxAUI_DOCK_TOP; return *this; }
- wxPaneInfo& Bottom() { dock_direction = wxAUI_DOCK_BOTTOM; return *this; }
- wxPaneInfo& Center() { dock_direction = wxAUI_DOCK_CENTER; return *this; }
- wxPaneInfo& Centre() { dock_direction = wxAUI_DOCK_CENTRE; return *this; }
- wxPaneInfo& Direction(int direction) { dock_direction = direction; return *this; }
- wxPaneInfo& Layer(int layer) { dock_layer = layer; return *this; }
- wxPaneInfo& Row(int row) { dock_row = row; return *this; }
- wxPaneInfo& Position(int pos) { dock_pos = pos; return *this; }
- wxPaneInfo& BestSize(const wxSize& size) { best_size = size; return *this; }
- wxPaneInfo& MinSize(const wxSize& size) { min_size = size; return *this; }
- wxPaneInfo& MaxSize(const wxSize& size) { max_size = size; return *this; }
- wxPaneInfo& BestSize(int x, int y) { best_size.Set(x,y); return *this; }
- wxPaneInfo& MinSize(int x, int y) { min_size.Set(x,y); return *this; }
- wxPaneInfo& MaxSize(int x, int y) { max_size.Set(x,y); return *this; }
- wxPaneInfo& FloatingPosition(const wxPoint& pos) { floating_pos = pos; return *this; }
- wxPaneInfo& FloatingPosition(int x, int y) { floating_pos.x = x; floating_pos.y = y; return *this; }
- wxPaneInfo& FloatingSize(const wxSize& size) { floating_size = size; return *this; }
- wxPaneInfo& FloatingSize(int x, int y) { floating_size.Set(x,y); return *this; }
- wxPaneInfo& Fixed() { return SetFlag(optionResizable, false); }
- wxPaneInfo& Resizable(bool resizable = true) { return SetFlag(optionResizable, resizable); }
- wxPaneInfo& Dock() { return SetFlag(optionFloating, false); }
- wxPaneInfo& Float() { return SetFlag(optionFloating, true); }
- wxPaneInfo& Hide() { return SetFlag(optionHidden, true); }
- wxPaneInfo& Show(bool show = true) { return SetFlag(optionHidden, !show); }
- wxPaneInfo& CaptionVisible(bool visible = true) { return SetFlag(optionCaption, visible); }
- wxPaneInfo& PaneBorder(bool visible = true) { return SetFlag(optionPaneBorder, visible); }
- wxPaneInfo& Gripper(bool visible = true) { return SetFlag(optionGripper, visible); }
- wxPaneInfo& GripperTop(bool attop = true) { return SetFlag(optionGripperTop, attop); }
- wxPaneInfo& CloseButton(bool visible = true) { return SetFlag(buttonClose, visible); }
- wxPaneInfo& MaximizeButton(bool visible = true) { return SetFlag(buttonMaximize, visible); }
- wxPaneInfo& MinimizeButton(bool visible = true) { return SetFlag(buttonMinimize, visible); }
- wxPaneInfo& PinButton(bool visible = true) { return SetFlag(buttonPin, visible); }
- wxPaneInfo& DestroyOnClose(bool b = true) { return SetFlag(optionDestroyOnClose, b); }
- wxPaneInfo& TopDockable(bool b = true) { return SetFlag(optionTopDockable, b); }
- wxPaneInfo& BottomDockable(bool b = true) { return SetFlag(optionBottomDockable, b); }
- wxPaneInfo& LeftDockable(bool b = true) { return SetFlag(optionLeftDockable, b); }
- wxPaneInfo& RightDockable(bool b = true) { return SetFlag(optionRightDockable, b); }
- wxPaneInfo& Floatable(bool b = true) { return SetFlag(optionFloatable, b); }
- wxPaneInfo& Movable(bool b = true) { return SetFlag(optionMovable, b); }
- wxPaneInfo& Dockable(bool b = true)
+
+#ifdef SWIG
+ %typemap(out) wxAuiPaneInfo& { $result = $self; Py_INCREF($result); }
+#endif
+ wxAuiPaneInfo& Window(wxWindow* w) { window = w; return *this; }
+ wxAuiPaneInfo& Name(const wxString& n) { name = n; return *this; }
+ wxAuiPaneInfo& Caption(const wxString& c) { caption = c; return *this; }
+ wxAuiPaneInfo& Left() { dock_direction = wxAUI_DOCK_LEFT; return *this; }
+ wxAuiPaneInfo& Right() { dock_direction = wxAUI_DOCK_RIGHT; return *this; }
+ wxAuiPaneInfo& Top() { dock_direction = wxAUI_DOCK_TOP; return *this; }
+ wxAuiPaneInfo& Bottom() { dock_direction = wxAUI_DOCK_BOTTOM; return *this; }
+ wxAuiPaneInfo& Center() { dock_direction = wxAUI_DOCK_CENTER; return *this; }
+ wxAuiPaneInfo& Centre() { dock_direction = wxAUI_DOCK_CENTRE; return *this; }
+ wxAuiPaneInfo& Direction(int direction) { dock_direction = direction; return *this; }
+ wxAuiPaneInfo& Layer(int layer) { dock_layer = layer; return *this; }
+ wxAuiPaneInfo& Row(int row) { dock_row = row; return *this; }
+ wxAuiPaneInfo& Position(int pos) { dock_pos = pos; return *this; }
+ wxAuiPaneInfo& BestSize(const wxSize& size) { best_size = size; return *this; }
+ wxAuiPaneInfo& MinSize(const wxSize& size) { min_size = size; return *this; }
+ wxAuiPaneInfo& MaxSize(const wxSize& size) { max_size = size; return *this; }
+ wxAuiPaneInfo& BestSize(int x, int y) { best_size.Set(x,y); return *this; }
+ wxAuiPaneInfo& MinSize(int x, int y) { min_size.Set(x,y); return *this; }
+ wxAuiPaneInfo& MaxSize(int x, int y) { max_size.Set(x,y); return *this; }
+ wxAuiPaneInfo& FloatingPosition(const wxPoint& pos) { floating_pos = pos; return *this; }
+ wxAuiPaneInfo& FloatingPosition(int x, int y) { floating_pos.x = x; floating_pos.y = y; return *this; }
+ wxAuiPaneInfo& FloatingSize(const wxSize& size) { floating_size = size; return *this; }
+ wxAuiPaneInfo& FloatingSize(int x, int y) { floating_size.Set(x,y); return *this; }
+ wxAuiPaneInfo& Fixed() { return SetFlag(optionResizable, false); }
+ wxAuiPaneInfo& Resizable(bool resizable = true) { return SetFlag(optionResizable, resizable); }
+ wxAuiPaneInfo& Dock() { return SetFlag(optionFloating, false); }
+ wxAuiPaneInfo& Float() { return SetFlag(optionFloating, true); }
+ wxAuiPaneInfo& Hide() { return SetFlag(optionHidden, true); }
+ wxAuiPaneInfo& Show(bool show = true) { return SetFlag(optionHidden, !show); }
+ wxAuiPaneInfo& CaptionVisible(bool visible = true) { return SetFlag(optionCaption, visible); }
+ wxAuiPaneInfo& Maximize() { return SetFlag(optionMaximized, true); }
+ wxAuiPaneInfo& Restore() { return SetFlag(optionMaximized, false); }
+ wxAuiPaneInfo& PaneBorder(bool visible = true) { return SetFlag(optionPaneBorder, visible); }
+ wxAuiPaneInfo& Gripper(bool visible = true) { return SetFlag(optionGripper, visible); }
+ wxAuiPaneInfo& GripperTop(bool attop = true) { return SetFlag(optionGripperTop, attop); }
+ wxAuiPaneInfo& CloseButton(bool visible = true) { return SetFlag(buttonClose, visible); }
+ wxAuiPaneInfo& MaximizeButton(bool visible = true) { return SetFlag(buttonMaximize, visible); }
+ wxAuiPaneInfo& MinimizeButton(bool visible = true) { return SetFlag(buttonMinimize, visible); }
+ wxAuiPaneInfo& PinButton(bool visible = true) { return SetFlag(buttonPin, visible); }
+ wxAuiPaneInfo& DestroyOnClose(bool b = true) { return SetFlag(optionDestroyOnClose, b); }
+ wxAuiPaneInfo& TopDockable(bool b = true) { return SetFlag(optionTopDockable, b); }
+ wxAuiPaneInfo& BottomDockable(bool b = true) { return SetFlag(optionBottomDockable, b); }
+ wxAuiPaneInfo& LeftDockable(bool b = true) { return SetFlag(optionLeftDockable, b); }
+ wxAuiPaneInfo& RightDockable(bool b = true) { return SetFlag(optionRightDockable, b); }
+ wxAuiPaneInfo& Floatable(bool b = true) { return SetFlag(optionFloatable, b); }
+ wxAuiPaneInfo& Movable(bool b = true) { return SetFlag(optionMovable, b); }
+ wxAuiPaneInfo& DockFixed(bool b = true) { return SetFlag(optionDockFixed, b); }
+
+ wxAuiPaneInfo& Dockable(bool b = true)
{
return TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b);
}
- wxPaneInfo& DefaultPane()
+ wxAuiPaneInfo& DefaultPane()
{
state |= optionTopDockable | optionBottomDockable |
optionLeftDockable | optionRightDockable |
optionCaption | optionPaneBorder | buttonClose;
return *this;
}
-
- wxPaneInfo& CentrePane() { return CenterPane(); }
- wxPaneInfo& CenterPane()
+
+ wxAuiPaneInfo& CentrePane() { return CenterPane(); }
+ wxAuiPaneInfo& CenterPane()
{
state = 0;
return Center().PaneBorder().Resizable();
}
-
- wxPaneInfo& ToolbarPane()
+
+ wxAuiPaneInfo& ToolbarPane()
{
DefaultPane();
state |= (optionToolbar | optionGripper);
return *this;
}
- wxPaneInfo& SetFlag(unsigned int flag, bool option_state)
+ wxAuiPaneInfo& SetFlag(unsigned int flag, bool option_state)
{
if (option_state)
state |= flag;
- else
+ else
state &= ~flag;
return *this;
}
-
+
bool HasFlag(unsigned int flag) const
{
- return (state & flag) ? true:false;
+ return (state & flag) != 0;
}
+#ifdef SWIG
+ %typemap(out) wxAuiPaneInfo& ;
+#endif
+
public:
- enum wxPaneState
+ // NOTE: You can add and subtract flags from this list,
+ // but do not change the values of the flags, because
+ // they are stored in a binary integer format in the
+ // perspective string. If you really need to change the
+ // values around, you'll have to ensure backwards-compatibility
+ // in the perspective loading code.
+ enum wxAuiPaneState
{
optionFloating = 1 << 0,
optionHidden = 1 << 1,
optionDestroyOnClose = 1 << 12,
optionToolbar = 1 << 13,
optionActive = 1 << 14,
- optionGripperTop = 1 << 15,
-
- buttonClose = 1 << 24,
- buttonMaximize = 1 << 25,
- buttonMinimize = 1 << 26,
- buttonPin = 1 << 27,
- buttonCustom1 = 1 << 28,
- buttonCustom2 = 1 << 29,
- buttonCustom3 = 1 << 30,
+ optionGripperTop = 1 << 15,
+ optionMaximized = 1 << 16,
+ optionDockFixed = 1 << 17,
+
+ buttonClose = 1 << 21,
+ buttonMaximize = 1 << 22,
+ buttonMinimize = 1 << 23,
+ buttonPin = 1 << 24,
+
+ buttonCustom1 = 1 << 26,
+ buttonCustom2 = 1 << 27,
+ buttonCustom3 = 1 << 28,
+
+ savedHiddenState = 1 << 30, // used internally
actionPane = 1 << 31 // used internally
};
wxString caption; // caption displayed on the window
wxWindow* window; // window that is in this pane
- wxWindow* frame; // floating frame window that holds the pane
+ wxFrame* frame; // floating frame window that holds the pane
unsigned int state; // a combination of wxPaneState values
int dock_direction; // dock direction (top, bottom, left, right, center)
wxSize floating_size; // size while floating
int dock_proportion; // proportion while docked
- wxPaneButtonArray buttons; // buttons on the pane
+ wxAuiPaneButtonArray buttons; // buttons on the pane
wxRect rect; // current rectangle (populated by wxAUI)
};
+class WXDLLIMPEXP_FWD_AUI wxAuiFloatingFrame;
-
-class WXDLLIMPEXP_AUI wxFrameManager : public wxEvtHandler
+class WXDLLIMPEXP_AUI wxAuiManager : public wxEvtHandler
{
-friend class wxFloatingPane;
+friend class wxAuiFloatingFrame;
public:
- wxFrameManager(wxFrame* frame = NULL,
+ wxAuiManager(wxWindow* managed_wnd = NULL,
unsigned int flags = wxAUI_MGR_DEFAULT);
- virtual ~wxFrameManager();
+ virtual ~wxAuiManager();
void UnInit();
-
+
void SetFlags(unsigned int flags);
unsigned int GetFlags() const;
-
- void SetFrame(wxFrame* frame);
- wxFrame* GetFrame() const;
-
- void SetArtProvider(wxDockArt* art_provider);
- wxDockArt* GetArtProvider() const;
- wxPaneInfo& GetPane(wxWindow* window);
- wxPaneInfo& GetPane(const wxString& name);
- wxPaneInfoArray& GetAllPanes();
+ void SetManagedWindow(wxWindow* managed_wnd);
+ wxWindow* GetManagedWindow() const;
+
+ static wxAuiManager* GetManager(wxWindow* window);
+
+#ifdef SWIG
+ %disownarg( wxAuiDockArt* art_provider );
+#endif
+ void SetArtProvider(wxAuiDockArt* art_provider);
+ wxAuiDockArt* GetArtProvider() const;
+
+ wxAuiPaneInfo& GetPane(wxWindow* window);
+ wxAuiPaneInfo& GetPane(const wxString& name);
+ wxAuiPaneInfoArray& GetAllPanes();
bool AddPane(wxWindow* window,
- const wxPaneInfo& pane_info);
-
+ const wxAuiPaneInfo& pane_info);
+
+ bool AddPane(wxWindow* window,
+ const wxAuiPaneInfo& pane_info,
+ const wxPoint& drop_pos);
+
bool AddPane(wxWindow* window,
int direction = wxLEFT,
const wxString& caption = wxEmptyString);
-
+
bool InsertPane(wxWindow* window,
- const wxPaneInfo& pane_info,
+ const wxAuiPaneInfo& insert_location,
int insert_level = wxAUI_INSERT_PANE);
-
+
bool DetachPane(wxWindow* window);
- wxString SavePerspective();
-
- bool LoadPerspective(const wxString& perspective,
- bool update = true);
-
void Update();
-private:
+ wxString SavePaneInfo(wxAuiPaneInfo& pane);
+ void LoadPaneInfo(wxString pane_part, wxAuiPaneInfo &pane);
+ wxString SavePerspective();
+ bool LoadPerspective(const wxString& perspective, bool update = true);
- void DrawHintRect(wxWindow* pane_window,
- const wxPoint& pt,
- const wxPoint& offset);
+ void SetDockSizeConstraint(double width_pct, double height_pct);
+ void GetDockSizeConstraint(double* width_pct, double* height_pct) const;
+
+ void ClosePane(wxAuiPaneInfo& pane_info);
+ void MaximizePane(wxAuiPaneInfo& pane_info);
+ void RestorePane(wxAuiPaneInfo& pane_info);
+ void RestoreMaximizedPane();
+
+public:
+
+ virtual wxAuiFloatingFrame* CreateFloatingFrame(wxWindow* parent, const wxAuiPaneInfo& p);
+ virtual bool CanDockPanel(const wxAuiPaneInfo & p);
+
+ void StartPaneDrag(
+ wxWindow* pane_window,
+ const wxPoint& offset);
+
+ wxRect CalculateHintRect(
+ wxWindow* pane_window,
+ const wxPoint& pt,
+ const wxPoint& offset);
+
+ void DrawHintRect(
+ wxWindow* pane_window,
+ const wxPoint& pt,
+ const wxPoint& offset);
+
+ virtual void ShowHint(const wxRect& rect);
+ virtual void HideHint();
+
+public:
+
+ // deprecated -- please use SetManagedWindow() and
+ // and GetManagedWindow() instead
+
+ wxDEPRECATED( void SetFrame(wxFrame* frame) );
+ wxDEPRECATED( wxFrame* GetFrame() const );
+
+protected:
+
+ void UpdateHintWindowConfig();
void DoFrameLayout();
void LayoutAddPane(wxSizer* container,
- wxDockInfo& dock,
- wxPaneInfo& pane,
- wxDockUIPartArray& uiparts,
+ wxAuiDockInfo& dock,
+ wxAuiPaneInfo& pane,
+ wxAuiDockUIPartArray& uiparts,
bool spacer_only);
void LayoutAddDock(wxSizer* container,
- wxDockInfo& dock,
- wxDockUIPartArray& uiparts,
+ wxAuiDockInfo& dock,
+ wxAuiDockUIPartArray& uiparts,
bool spacer_only);
- wxSizer* LayoutAll(wxPaneInfoArray& panes,
- wxDockInfoArray& docks,
- wxDockUIPartArray& uiparts,
+ wxSizer* LayoutAll(wxAuiPaneInfoArray& panes,
+ wxAuiDockInfoArray& docks,
+ wxAuiDockUIPartArray& uiparts,
bool spacer_only = false);
- bool DoDrop(wxDockInfoArray& docks,
- wxPaneInfoArray& panes,
- wxPaneInfo& drop,
+ virtual bool ProcessDockResult(wxAuiPaneInfo& target,
+ const wxAuiPaneInfo& new_pos);
+
+ bool DoDrop(wxAuiDockInfoArray& docks,
+ wxAuiPaneInfoArray& panes,
+ wxAuiPaneInfo& drop,
const wxPoint& pt,
const wxPoint& action_offset = wxPoint(0,0));
- wxPaneInfo& LookupPane(wxWindow* window);
- wxPaneInfo& LookupPane(const wxString& name);
- wxDockUIPart* HitTest(int x, int y);
- wxDockUIPart* GetPanePart(wxWindow* pane);
- int GetDockPixelOffset(wxPaneInfo& test);
+ wxAuiDockUIPart* HitTest(int x, int y);
+ wxAuiDockUIPart* GetPanePart(wxWindow* pane);
+ int GetDockPixelOffset(wxAuiPaneInfo& test);
void OnFloatingPaneMoveStart(wxWindow* window);
- void OnFloatingPaneMoving(wxWindow* window);
- void OnFloatingPaneMoved(wxWindow* window);
+ void OnFloatingPaneMoving(wxWindow* window, wxDirection dir );
+ void OnFloatingPaneMoved(wxWindow* window, wxDirection dir);
void OnFloatingPaneActivated(wxWindow* window);
- void OnFloatingPaneClosed(wxWindow* window);
+ void OnFloatingPaneClosed(wxWindow* window, wxCloseEvent& evt);
void OnFloatingPaneResized(wxWindow* window, const wxSize& size);
void Render(wxDC* dc);
void Repaint(wxDC* dc = NULL);
- void ProcessMgrEvent(wxFrameManagerEvent& event);
- void UpdateButtonOnScreen(wxDockUIPart* button_ui_part,
+ void ProcessMgrEvent(wxAuiManagerEvent& event);
+ void UpdateButtonOnScreen(wxAuiDockUIPart* button_ui_part,
const wxMouseEvent& event);
- void GetPanePositionsAndSizes(wxDockInfo& dock,
+ void GetPanePositionsAndSizes(wxAuiDockInfo& dock,
wxArrayInt& positions,
wxArrayInt& sizes);
- void ShowHint(const wxRect& rect);
- void HideHint();
- void RemoveHint();
-private:
- // events
- void OnPaint(wxPaintEvent& event);
- void OnEraseBackground(wxEraseEvent& event);
- void OnSize(wxSizeEvent& event);
- void OnSetCursor(wxSetCursorEvent& event);
- void OnLeftDown(wxMouseEvent& event);
- void OnLeftUp(wxMouseEvent& event);
- void OnMotion(wxMouseEvent& event);
- void OnLeaveWindow(wxMouseEvent& event);
- void OnPaneButton(wxFrameManagerEvent& event);
- void OnChildFocus(wxChildFocusEvent& event);
- void OnHintFadeTimer(wxTimerEvent& event);
+public:
+
+ // public events (which can be invoked externally)
+ void OnRender(wxAuiManagerEvent& evt);
+ void OnPaneButton(wxAuiManagerEvent& evt);
-private:
+protected:
+
+ // protected events
+ void OnPaint(wxPaintEvent& evt);
+ void OnEraseBackground(wxEraseEvent& evt);
+ void OnSize(wxSizeEvent& evt);
+ void OnSetCursor(wxSetCursorEvent& evt);
+ void OnLeftDown(wxMouseEvent& evt);
+ void OnLeftUp(wxMouseEvent& evt);
+ void OnMotion(wxMouseEvent& evt);
+ void OnLeaveWindow(wxMouseEvent& evt);
+ void OnChildFocus(wxChildFocusEvent& evt);
+ void OnHintFadeTimer(wxTimerEvent& evt);
+ void OnFindManager(wxAuiManagerEvent& evt);
+
+protected:
enum
{
actionDragFloatingPane
};
-private:
+protected:
- wxFrame* m_frame; // the frame being managed
- wxDockArt* m_art; // dock art object which does all drawing
+ wxWindow* m_frame; // the window being managed
+ wxAuiDockArt* m_art; // dock art object which does all drawing
unsigned int m_flags; // manager flags wxAUI_MGR_*
- wxPaneInfoArray m_panes; // array of panes structures
- wxDockInfoArray m_docks; // array of docks structures
- wxDockUIPartArray m_uiparts; // array of UI parts (captions, buttons, etc)
+ wxAuiPaneInfoArray m_panes; // array of panes structures
+ wxAuiDockInfoArray m_docks; // array of docks structures
+ wxAuiDockUIPartArray m_uiparts; // array of UI parts (captions, buttons, etc)
int m_action; // current mouse action
wxPoint m_action_start; // position where the action click started
wxPoint m_action_offset; // offset from upper left of the item clicked
- wxDockUIPart* m_action_part; // ptr to the part the action happened to
+ wxAuiDockUIPart* m_action_part; // ptr to the part the action happened to
wxWindow* m_action_window; // action frame or window (NULL if none)
wxRect m_action_hintrect; // hint rectangle for the action
- wxDockUIPart* m_hover_button;// button uipart being hovered over
+ wxRect m_last_rect;
+ wxAuiDockUIPart* m_hover_button;// button uipart being hovered over
wxRect m_last_hint; // last hint rectangle
wxPoint m_last_mouse_move; // last mouse move position (see OnMotion)
+ bool m_skipping;
+ bool m_has_maximized;
+
+ double m_dock_constraint_x; // 0.0 .. 1.0; max pct of window width a dock can consume
+ double m_dock_constraint_y; // 0.0 .. 1.0; max pct of window height a dock can consume
+
+ wxFrame* m_hint_wnd; // transparent hint window, if supported by platform
+ wxTimer m_hint_fadetimer; // transparent fade timer
+ wxByte m_hint_fadeamt; // transparent fade amount
+ wxByte m_hint_fademax; // maximum value of hint fade
- wxWindow* m_hint_wnd; // transparent hint window (for now, only msw)
- wxTimer m_hint_fadetimer; // transparent fade timer (for now, only msw)
- int m_hint_fadeamt; // transparent fade amount (for now, only msw)
-
+ void* m_reserved;
+
+#ifndef SWIG
DECLARE_EVENT_TABLE()
+ DECLARE_CLASS(wxAuiManager)
+#endif // SWIG
};
// event declarations/classes
-class WXDLLIMPEXP_AUI wxFrameManagerEvent : public wxEvent
+class WXDLLIMPEXP_AUI wxAuiManagerEvent : public wxEvent
{
public:
- wxFrameManagerEvent(wxEventType type) : wxEvent(0, type)
+ wxAuiManagerEvent(wxEventType type=wxEVT_NULL) : wxEvent(0, type)
{
+ manager = NULL;
pane = NULL;
button = 0;
+ veto_flag = false;
+ canveto_flag = true;
+ dc = NULL;
}
-
- wxFrameManagerEvent(const wxFrameManagerEvent& c) : wxEvent(c)
+#ifndef SWIG
+ wxAuiManagerEvent(const wxAuiManagerEvent& c) : wxEvent(c)
{
+ manager = c.manager;
pane = c.pane;
button = c.button;
+ veto_flag = c.veto_flag;
+ canveto_flag = c.canveto_flag;
+ dc = c.dc;
}
+#endif
+ wxEvent *Clone() const { return new wxAuiManagerEvent(*this); }
- wxEvent *Clone() const { return new wxFrameManagerEvent(*this); }
-
- void SetPane(wxPaneInfo* p) { pane = p; }
+ void SetManager(wxAuiManager* mgr) { manager = mgr; }
+ void SetPane(wxAuiPaneInfo* p) { pane = p; }
void SetButton(int b) { button = b; }
- wxPaneInfo* GetPane() { return pane; }
- int GetButton() { return button; }
+ void SetDC(wxDC* pdc) { dc = pdc; }
+
+ wxAuiManager* GetManager() const { return manager; }
+ wxAuiPaneInfo* GetPane() const { return pane; }
+ int GetButton() const { return button; }
+ wxDC* GetDC() const { return dc; }
+
+ void Veto(bool veto = true) { veto_flag = veto; }
+ bool GetVeto() const { return veto_flag; }
+ void SetCanVeto(bool can_veto) { canveto_flag = can_veto; }
+ bool CanVeto() const { return canveto_flag && veto_flag; }
public:
- wxPaneInfo* pane;
+ wxAuiManager* manager;
+ wxAuiPaneInfo* pane;
int button;
+ bool veto_flag;
+ bool canveto_flag;
+ wxDC* dc;
+
+#ifndef SWIG
+private:
+ DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxAuiManagerEvent)
+#endif
};
-class WXDLLIMPEXP_AUI wxDockInfo
+class WXDLLIMPEXP_AUI wxAuiDockInfo
{
public:
- wxDockInfo()
+ wxAuiDockInfo()
{
dock_direction = 0;
dock_layer = 0;
resizable = true;
fixed = false;
toolbar = false;
+ reserved1 = false;
}
- wxDockInfo(const wxDockInfo& c)
+#ifndef SWIG
+ wxAuiDockInfo(const wxAuiDockInfo& c)
{
dock_direction = c.dock_direction;
dock_layer = c.dock_layer;
toolbar = c.toolbar;
panes = c.panes;
rect = c.rect;
+ reserved1 = c.reserved1;
}
- wxDockInfo& operator=(const wxDockInfo& c)
+ wxAuiDockInfo& operator=(const wxAuiDockInfo& c)
{
dock_direction = c.dock_direction;
dock_layer = c.dock_layer;
toolbar = c.toolbar;
panes = c.panes;
rect = c.rect;
+ reserved1 = c.reserved1;
return *this;
}
+#endif // SWIG
- bool IsOk() const { return (dock_direction != 0) ? true : false; }
- bool IsHorizontal() const { return (dock_direction == wxAUI_DOCK_TOP ||
- dock_direction == wxAUI_DOCK_BOTTOM) ? true:false; }
- bool IsVertical() const { return (dock_direction == wxAUI_DOCK_LEFT ||
+ bool IsOk() const { return dock_direction != 0; }
+ bool IsHorizontal() const { return dock_direction == wxAUI_DOCK_TOP ||
+ dock_direction == wxAUI_DOCK_BOTTOM; }
+ bool IsVertical() const { return dock_direction == wxAUI_DOCK_LEFT ||
dock_direction == wxAUI_DOCK_RIGHT ||
- dock_direction == wxAUI_DOCK_CENTER) ? true:false; }
+ dock_direction == wxAUI_DOCK_CENTER; }
public:
- wxPaneInfoPtrArray panes; // array of panes
+ wxAuiPaneInfoPtrArray panes; // array of panes
wxRect rect; // current rectangle
int dock_direction; // dock direction (top, bottom, left, right, center)
int dock_layer; // layer number (0 = innermost layer)
bool toolbar; // flag indicating dock contains only toolbars
bool fixed; // flag indicating that the dock operates on
// absolute coordinates as opposed to proportional
+ bool reserved1;
};
-class WXDLLIMPEXP_AUI wxDockUIPart
+class WXDLLIMPEXP_AUI wxAuiDockUIPart
{
public:
enum
typePaneSizer,
typeBackground,
typePaneBorder,
- typePaneButton,
+ typePaneButton
};
int type; // ui part type (see enum above)
int orientation; // orientation (either wxHORIZONTAL or wxVERTICAL)
- wxDockInfo* dock; // which dock the item is associated with
- wxPaneInfo* pane; // which pane the item is associated with
- wxPaneButton* button; // which pane button the item is associated with
+ wxAuiDockInfo* dock; // which dock the item is associated with
+ wxAuiPaneInfo* pane; // which pane the item is associated with
+ wxAuiPaneButton* button; // which pane button the item is associated with
wxSizer* cont_sizer; // the part's containing sizer
wxSizerItem* sizer_item; // the sizer item of the part
wxRect rect; // client coord rectangle of the part itself
};
-class WXDLLIMPEXP_AUI wxPaneButton
+class WXDLLIMPEXP_AUI wxAuiPaneButton
{
public:
int button_id; // id of the button (e.g. buttonClose)
-
+#ifndef SWIG
// wx event machinery
-
-// right now the only event that works is wxEVT_AUI_PANEBUTTON. A full
-// spectrum of events will be implemented in the next incremental version
-
BEGIN_DECLARE_EVENT_TYPES()
- DECLARE_EVENT_TYPE(wxEVT_AUI_PANEBUTTON, 0)
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANE_BUTTON, 0)
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANE_CLOSE, 0)
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANE_MAXIMIZE, 0)
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANE_RESTORE, 0)
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_RENDER, 0)
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_FIND_MANAGER, 0)
END_DECLARE_EVENT_TYPES()
-typedef void (wxEvtHandler::*wxFrameManagerEventFunction)(wxFrameManagerEvent&);
-
-#define wxFrameManagerEventHandler(func) \
- (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxFrameManagerEventFunction, &func)
-
-#define EVT_AUI_PANEBUTTON(func) \
- wx__DECLARE_EVT0(wxEVT_AUI_PANEBUTTON, wxFrameManagerEventHandler(func))
+typedef void (wxEvtHandler::*wxAuiManagerEventFunction)(wxAuiManagerEvent&);
+
+#define wxAuiManagerEventHandler(func) \
+ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxAuiManagerEventFunction, &func)
+
+#define EVT_AUI_PANE_BUTTON(func) \
+ wx__DECLARE_EVT0(wxEVT_AUI_PANE_BUTTON, wxAuiManagerEventHandler(func))
+#define EVT_AUI_PANE_CLOSE(func) \
+ wx__DECLARE_EVT0(wxEVT_AUI_PANE_CLOSE, wxAuiManagerEventHandler(func))
+#define EVT_AUI_PANE_MAXIMIZE(func) \
+ wx__DECLARE_EVT0(wxEVT_AUI_PANE_MAXIMIZE, wxAuiManagerEventHandler(func))
+#define EVT_AUI_PANE_RESTORE(func) \
+ wx__DECLARE_EVT0(wxEVT_AUI_PANE_RESTORE, wxAuiManagerEventHandler(func))
+#define EVT_AUI_RENDER(func) \
+ wx__DECLARE_EVT0(wxEVT_AUI_RENDER, wxAuiManagerEventHandler(func))
+#define EVT_AUI_FIND_MANAGER(func) \
+ wx__DECLARE_EVT0(wxEVT_AUI_FIND_MANAGER, wxAuiManagerEventHandler(func))
+
+#else
+
+%constant wxEventType wxEVT_AUI_PANE_BUTTON;
+%constant wxEventType wxEVT_AUI_PANE_CLOSE;
+%constant wxEventType wxEVT_AUI_PANE_MAXIMIZE;
+%constant wxEventType wxEVT_AUI_PANE_RESTORE;
+%constant wxEventType wxEVT_AUI_RENDER;
+%constant wxEventType wxEVT_AUI_FIND_MANAGER;
+
+%pythoncode {
+ EVT_AUI_PANE_BUTTON = wx.PyEventBinder( wxEVT_AUI_PANE_BUTTON )
+ EVT_AUI_PANE_CLOSE = wx.PyEventBinder( wxEVT_AUI_PANE_CLOSE )
+ EVT_AUI_PANE_MAXIMIZE = wx.PyEventBinder( wxEVT_AUI_PANE_MAXIMIZE )
+ EVT_AUI_PANE_RESTORE = wx.PyEventBinder( wxEVT_AUI_PANE_RESTORE )
+ EVT_AUI_RENDER = wx.PyEventBinder( wxEVT_AUI_RENDER )
+ EVT_AUI_FIND_MANAGER = wx.PyEventBinder( wxEVT_AUI_FIND_MANAGER )
+}
+#endif // SWIG
#endif // wxUSE_AUI
#endif //_WX_FRAMEMANAGER_H_
projects / wxWidgets.git / blobdiff