X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ce15b45fef3d8d62681f496b4e6e343af6d36031..bdb40fa63eafd1b6b0b25e2d8142bff75a92421d:/include/wx/aui/framemanager.h diff --git a/include/wx/aui/framemanager.h b/include/wx/aui/framemanager.h index 863bc7a7dc..94ff9568f0 100644 --- a/include/wx/aui/framemanager.h +++ b/include/wx/aui/framemanager.h @@ -47,6 +47,7 @@ enum wxAuiManagerOption wxAUI_MGR_RECTANGLE_HINT = 1 << 5, wxAUI_MGR_HINT_FADE = 1 << 6, wxAUI_MGR_NO_VENETIAN_BLINDS_FADE = 1 << 7, + wxAUI_MGR_LIVE_RESIZE = 1 << 8, wxAUI_MGR_DEFAULT = wxAUI_MGR_ALLOW_FLOATING | wxAUI_MGR_TRANSPARENT_HINT | @@ -57,23 +58,23 @@ enum wxAuiManagerOption 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 wxAuiPaneDockArtGradients @@ -89,7 +90,8 @@ enum wxAuiPaneButtonState 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_HIDDEN = 1 << 4, + wxAUI_BUTTON_STATE_CHECKED = 1 << 5 }; enum wxAuiButtonId @@ -165,7 +167,7 @@ public: } ~wxAuiPaneInfo() {} - + #ifndef SWIG wxAuiPaneInfo(const wxAuiPaneInfo& c) { @@ -220,11 +222,13 @@ public: source.window = window; source.frame = frame; source.buttons = buttons; + wxCHECK_RET(source.IsValid(), + "window settings and pane settings are incompatible"); // now assign *this = source; } - bool IsOk() const { return (window != NULL) ? true : false; } + bool IsOk() const { return window != NULL; } bool IsFixed() const { return !HasFlag(optionResizable); } bool IsResizable() const { return HasFlag(optionResizable); } bool IsShown() const { return !HasFlag(optionHidden); } @@ -251,7 +255,15 @@ public: #ifdef SWIG %typemap(out) wxAuiPaneInfo& { $result = $self; Py_INCREF($result); } #endif - wxAuiPaneInfo& Window(wxWindow* w) { window = w; return *this; } + wxAuiPaneInfo& Window(wxWindow* w) + { + wxAuiPaneInfo test(*this); + test.window = w; + wxCHECK_MSG(test.IsValid(), *this, + "window settings and pane settings are incompatible"); + *this = test; + 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; } @@ -297,9 +309,7 @@ public: 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& SaveHidden() { return SetFlag(optionSavedHidden, HasFlag(optionHidden)); } - wxAuiPaneInfo& RestoreHidden() { return SetFlag(optionHidden, HasFlag(optionSavedHidden)); } + wxAuiPaneInfo& DockFixed(bool b = true) { return SetFlag(optionDockFixed, b); } wxAuiPaneInfo& Dockable(bool b = true) { @@ -308,10 +318,14 @@ public: wxAuiPaneInfo& DefaultPane() { - state |= optionTopDockable | optionBottomDockable | + wxAuiPaneInfo test(*this); + test.state |= optionTopDockable | optionBottomDockable | optionLeftDockable | optionRightDockable | optionFloatable | optionMovable | optionResizable | optionCaption | optionPaneBorder | buttonClose; + wxCHECK_MSG(test.IsValid(), *this, + "window settings and pane settings are incompatible"); + *this = test; return *this; } @@ -332,26 +346,36 @@ public: return *this; } - wxAuiPaneInfo& SetFlag(unsigned int flag, bool option_state) + wxAuiPaneInfo& SetFlag(int flag, bool option_state) { + wxAuiPaneInfo test(*this); if (option_state) - state |= flag; - else - state &= ~flag; + test.state |= flag; + else + test.state &= ~flag; + wxCHECK_MSG(test.IsValid(), *this, + "window settings and pane settings are incompatible"); + *this = test; return *this; } - bool HasFlag(unsigned int flag) const + bool HasFlag(int flag) const { - return (state & flag) ? true:false; + return (state & flag) != 0; } #ifdef SWIG %typemap(out) wxAuiPaneInfo& ; #endif - + public: + // 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, @@ -371,15 +395,18 @@ public: optionActive = 1 << 14, optionGripperTop = 1 << 15, optionMaximized = 1 << 16, - optionSavedHidden = 1 << 17, - - buttonClose = 1 << 24, - buttonMaximize = 1 << 25, - buttonMinimize = 1 << 26, - buttonPin = 1 << 27, - buttonCustom1 = 1 << 28, - buttonCustom2 = 1 << 29, - buttonCustom3 = 1 << 30, + 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 }; @@ -407,15 +434,17 @@ public: wxAuiPaneButtonArray buttons; // buttons on the pane wxRect rect; // current rectangle (populated by wxAUI) + + bool IsValid() const; }; -class WXDLLIMPEXP_AUI wxAuiFloatingFrame; +class WXDLLIMPEXP_FWD_AUI wxAuiFloatingFrame; class WXDLLIMPEXP_AUI wxAuiManager : public wxEvtHandler { -friend class wxAuiFloatingFrame; + friend class wxAuiFloatingFrame; public: @@ -430,9 +459,8 @@ public: void SetManagedWindow(wxWindow* managed_wnd); wxWindow* GetManagedWindow() const; -#ifdef SWIG - %disownarg( wxAuiDockArt* art_provider ); -#endif + static wxAuiManager* GetManager(wxWindow* window); + void SetArtProvider(wxAuiDockArt* art_provider); wxAuiDockArt* GetArtProvider() const; @@ -442,7 +470,7 @@ public: bool AddPane(wxWindow* window, const wxAuiPaneInfo& pane_info); - + bool AddPane(wxWindow* window, const wxAuiPaneInfo& pane_info, const wxPoint& drop_pos); @@ -456,49 +484,58 @@ public: int insert_level = wxAUI_INSERT_PANE); bool DetachPane(wxWindow* window); - - void ClosePane(wxAuiPaneInfo& pane_info); - void MaximizePane(wxAuiPaneInfo& pane_info); - void RestorePane(wxAuiPaneInfo& pane_info); - void RestoreMaximizedPane(); + + void Update(); wxString SavePaneInfo(wxAuiPaneInfo& pane); void LoadPaneInfo(wxString pane_part, wxAuiPaneInfo &pane); - wxString SavePerspective(); + bool LoadPerspective(const wxString& perspective, bool update = true); - bool LoadPerspective(const wxString& perspective, - bool update = true); - - void Update(); + 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); - 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(); + void OnHintActivate(wxActivateEvent& event); + 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, @@ -526,8 +563,6 @@ protected: const wxPoint& pt, const wxPoint& action_offset = wxPoint(0,0)); - wxAuiPaneInfo& LookupPane(wxWindow* window); - wxAuiPaneInfo& LookupPane(const wxString& name); wxAuiDockUIPart* HitTest(int x, int y); wxAuiDockUIPart* GetPanePart(wxWindow* pane); int GetDockPixelOffset(wxAuiPaneInfo& test); @@ -536,7 +571,7 @@ protected: void OnFloatingPaneMoved(wxWindow* window, wxDirection dir); void OnFloatingPaneActivated(wxWindow* window); void OnFloatingPaneClosed(wxWindow* window, wxCloseEvent& evt); - void OnFloatingPaneResized(wxWindow* window, const wxSize& size); + void OnFloatingPaneResized(wxWindow* window, const wxRect& rect); void Render(wxDC* dc); void Repaint(wxDC* dc = NULL); void ProcessMgrEvent(wxAuiManagerEvent& event); @@ -546,6 +581,8 @@ protected: wxArrayInt& positions, wxArrayInt& sizes); + /// Ends a resize action, or for live update, resizes the sash + bool DoEndResizeAction(wxMouseEvent& event); public: @@ -563,9 +600,11 @@ protected: void OnLeftDown(wxMouseEvent& evt); void OnLeftUp(wxMouseEvent& evt); void OnMotion(wxMouseEvent& evt); + void OnCaptureLost(wxMouseCaptureLostEvent& evt); void OnLeaveWindow(wxMouseEvent& evt); void OnChildFocus(wxChildFocusEvent& evt); void OnHintFadeTimer(wxTimerEvent& evt); + void OnFindManager(wxAuiManagerEvent& evt); protected: @@ -595,20 +634,27 @@ protected: 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 - bool m_skipping; - bool m_has_maximized; 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) + int m_currentDragItem; + 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 + void* m_reserved; + #ifndef SWIG DECLARE_EVENT_TABLE() + DECLARE_CLASS(wxAuiManager) #endif // SWIG }; @@ -621,6 +667,7 @@ class WXDLLIMPEXP_AUI wxAuiManagerEvent : public wxEvent public: wxAuiManagerEvent(wxEventType type=wxEVT_NULL) : wxEvent(0, type) { + manager = NULL; pane = NULL; button = 0; veto_flag = false; @@ -630,6 +677,7 @@ public: #ifndef SWIG wxAuiManagerEvent(const wxAuiManagerEvent& c) : wxEvent(c) { + manager = c.manager; pane = c.pane; button = c.button; veto_flag = c.veto_flag; @@ -639,20 +687,23 @@ public: #endif wxEvent *Clone() const { return new wxAuiManagerEvent(*this); } + void SetManager(wxAuiManager* mgr) { manager = mgr; } void SetPane(wxAuiPaneInfo* p) { pane = p; } void SetButton(int b) { button = b; } void SetDC(wxDC* pdc) { dc = pdc; } - - wxAuiPaneInfo* GetPane() { return pane; } - int GetButton() { return button; } - wxDC* GetDC() { return dc; } - + + 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: + wxAuiManager* manager; wxAuiPaneInfo* pane; int button; bool veto_flag; @@ -679,6 +730,7 @@ public: resizable = true; fixed = false; toolbar = false; + reserved1 = false; } #ifndef SWIG @@ -694,6 +746,7 @@ public: toolbar = c.toolbar; panes = c.panes; rect = c.rect; + reserved1 = c.reserved1; } wxAuiDockInfo& operator=(const wxAuiDockInfo& c) @@ -708,16 +761,17 @@ public: 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: wxAuiPaneInfoPtrArray panes; // array of panes wxRect rect; // current rectangle @@ -730,6 +784,7 @@ public: 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; }; @@ -769,46 +824,48 @@ public: #ifndef SWIG -// wx event machinery -BEGIN_DECLARE_EVENT_TYPES() - DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANEBUTTON, 0) - DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANECLOSE, 0) - DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANEMAXIMIZE, 0) - DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANERESTORE, 0) - DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_RENDER, 0) -END_DECLARE_EVENT_TYPES() +wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_AUI_PANE_BUTTON, wxAuiManagerEvent ); +wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_AUI_PANE_CLOSE, wxAuiManagerEvent ); +wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_AUI_PANE_MAXIMIZE, wxAuiManagerEvent ); +wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_AUI_PANE_RESTORE, wxAuiManagerEvent ); +wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_AUI_RENDER, wxAuiManagerEvent ); +wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_AUI_FIND_MANAGER, wxAuiManagerEvent ); typedef void (wxEvtHandler::*wxAuiManagerEventFunction)(wxAuiManagerEvent&); #define wxAuiManagerEventHandler(func) \ - (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxAuiManagerEventFunction, &func) - -#define EVT_AUI_PANEBUTTON(func) \ - wx__DECLARE_EVT0(wxEVT_AUI_PANEBUTTON, wxAuiManagerEventHandler(func)) -#define EVT_AUI_PANECLOSE(func) \ - wx__DECLARE_EVT0(wxEVT_AUI_PANECLOSE, wxAuiManagerEventHandler(func)) -#define EVT_AUI_PANEMAXIMIZE(func) \ - wx__DECLARE_EVT0(wxEVT_AUI_PANEMAXIMIZE, wxAuiManagerEventHandler(func)) -#define EVT_AUI_PANERESTORE(func) \ - wx__DECLARE_EVT0(wxEVT_AUI_PANERESTORE, wxAuiManagerEventHandler(func)) + wxEVENT_HANDLER_CAST(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_PANEBUTTON; -%constant wxEventType wxEVT_AUI_PANECLOSE; -%constant wxEventType wxEVT_AUI_PANEMAXIMIZE; -%constant wxEventType wxEVT_AUI_PANERESTORE; +%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_PANEBUTTON = wx.PyEventBinder( wxEVT_AUI_PANEBUTTON ) - EVT_AUI_PANECLOSE = wx.PyEventBinder( wxEVT_AUI_PANECLOSE ) - EVT_AUI_PANEMAXIMIZE = wx.PyEventBinder( wxEVT_AUI_PANEMAXIMIZE ) - EVT_AUI_PANERESTORE = wx.PyEventBinder( wxEVT_AUI_PANERESTORE ) + 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