X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/bc07ab17bf5370f452e899128bf89cc7ca7b98f0..14619f10b0bdb630206607abd0ce0319d45e095a:/include/wx/aui/framemanager.h diff --git a/include/wx/aui/framemanager.h b/include/wx/aui/framemanager.h index 5b81ced399..2217d7cad4 100644 --- a/include/wx/aui/framemanager.h +++ b/include/wx/aui/framemanager.h @@ -25,6 +25,7 @@ #include "wx/window.h" #include "wx/timer.h" #include "wx/sizer.h" +#include "wx/bitmap.h" enum wxAuiManagerDock { @@ -47,6 +48,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 | @@ -166,12 +168,13 @@ public: } ~wxAuiPaneInfo() {} - + #ifndef SWIG wxAuiPaneInfo(const wxAuiPaneInfo& c) { name = c.name; caption = c.caption; + icon = c.icon; window = c.window; frame = c.frame; state = c.state; @@ -221,11 +224,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); } @@ -236,6 +241,11 @@ public: bool IsBottomDockable() const { return HasFlag(optionBottomDockable); } bool IsLeftDockable() const { return HasFlag(optionLeftDockable); } bool IsRightDockable() const { return HasFlag(optionRightDockable); } + bool IsDockable() const + { + return HasFlag(optionTopDockable | optionBottomDockable | + optionLeftDockable | optionRightDockable); + } bool IsFloatable() const { return HasFlag(optionFloatable); } bool IsMovable() const { return HasFlag(optionMovable); } bool IsDestroyOnClose() const { return HasFlag(optionDestroyOnClose); } @@ -252,9 +262,18 @@ 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& Icon(const wxBitmap& b) { icon = b; 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; } @@ -298,9 +317,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) { @@ -309,10 +326,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; } @@ -333,29 +354,33 @@ 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 + // 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. @@ -378,21 +403,25 @@ 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 }; public: wxString name; // name of the pane wxString caption; // caption displayed on the window + wxBitmap icon; // icon of the pane, may be invalid wxWindow* window; // window that is in this pane wxFrame* frame; // floating frame window that holds the pane @@ -413,20 +442,23 @@ 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: - wxAuiManager(wxWindow* managed_wnd = NULL, + wxAuiManager(wxWindow* managedWnd = NULL, unsigned int flags = wxAUI_MGR_DEFAULT); virtual ~wxAuiManager(); void UnInit(); @@ -434,15 +466,12 @@ public: void SetFlags(unsigned int flags); unsigned int GetFlags() const; - void SetManagedWindow(wxWindow* managed_wnd); + void SetManagedWindow(wxWindow* managedWnd); wxWindow* GetManagedWindow() const; static wxAuiManager* GetManager(wxWindow* window); -#ifdef SWIG - %disownarg( wxAuiDockArt* art_provider ); -#endif - void SetArtProvider(wxAuiDockArt* art_provider); + void SetArtProvider(wxAuiDockArt* artProvider); wxAuiDockArt* GetArtProvider() const; wxAuiPaneInfo& GetPane(wxWindow* window); @@ -450,96 +479,99 @@ public: wxAuiPaneInfoArray& GetAllPanes(); bool AddPane(wxWindow* window, - const wxAuiPaneInfo& pane_info); - + const wxAuiPaneInfo& paneInfo); + bool AddPane(wxWindow* window, - const wxAuiPaneInfo& pane_info, - const wxPoint& drop_pos); + const wxAuiPaneInfo& paneInfo, + const wxPoint& dropPos); bool AddPane(wxWindow* window, int direction = wxLEFT, const wxString& caption = wxEmptyString); bool InsertPane(wxWindow* window, - const wxAuiPaneInfo& insert_location, - int insert_level = wxAUI_INSERT_PANE); + const wxAuiPaneInfo& insertLocation, + int insertLevel = wxAUI_INSERT_PANE); bool DetachPane(wxWindow* window); - - void ClosePane(wxAuiPaneInfo& pane_info); - void MaximizePane(wxAuiPaneInfo& pane_info); - void RestorePane(wxAuiPaneInfo& pane_info); - void RestoreMaximizedPane(); - wxString SavePaneInfo(wxAuiPaneInfo& pane); - void LoadPaneInfo(wxString pane_part, wxAuiPaneInfo &pane); + void Update(); + wxString SavePaneInfo(wxAuiPaneInfo& pane); + void LoadPaneInfo(wxString panePart, wxAuiPaneInfo &pane); wxString SavePerspective(); + bool LoadPerspective(const wxString& perspective, bool update = true); - bool LoadPerspective(const wxString& perspective, - bool update = true); + void SetDockSizeConstraint(double widthPct, double heightPct); + void GetDockSizeConstraint(double* widthPct, double* heightPct) const; - void Update(); + void ClosePane(wxAuiPaneInfo& paneInfo); + void MaximizePane(wxAuiPaneInfo& paneInfo); + void RestorePane(wxAuiPaneInfo& paneInfo); + void RestoreMaximizedPane(); public: virtual wxAuiFloatingFrame* CreateFloatingFrame(wxWindow* parent, const wxAuiPaneInfo& p); + virtual bool CanDockPanel(const wxAuiPaneInfo & p); void StartPaneDrag( - wxWindow* pane_window, + wxWindow* paneWindow, const wxPoint& offset); wxRect CalculateHintRect( - wxWindow* pane_window, + wxWindow* paneWindow, const wxPoint& pt, const wxPoint& offset); - + void DrawHintRect( - wxWindow* pane_window, + wxWindow* paneWindow, 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, wxAuiDockInfo& dock, wxAuiPaneInfo& pane, wxAuiDockUIPartArray& uiparts, - bool spacer_only); + bool spacerOnly); void LayoutAddDock(wxSizer* container, wxAuiDockInfo& dock, - wxAuiDockUIPartArray& uiparts, - bool spacer_only); + wxAuiDockUIPartArray& uiParts, + bool spacerOnly); wxSizer* LayoutAll(wxAuiPaneInfoArray& panes, wxAuiDockInfoArray& docks, - wxAuiDockUIPartArray& uiparts, - bool spacer_only = false); + wxAuiDockUIPartArray & uiParts, + bool spacerOnly = false); virtual bool ProcessDockResult(wxAuiPaneInfo& target, - const wxAuiPaneInfo& new_pos); + const wxAuiPaneInfo& newPos); bool DoDrop(wxAuiDockInfoArray& docks, wxAuiPaneInfoArray& panes, wxAuiPaneInfo& drop, const wxPoint& pt, - const wxPoint& action_offset = wxPoint(0,0)); + const wxPoint& actionOffset = wxPoint(0,0)); wxAuiDockUIPart* HitTest(int x, int y); wxAuiDockUIPart* GetPanePart(wxWindow* pane); @@ -549,16 +581,20 @@ 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); - void UpdateButtonOnScreen(wxAuiDockUIPart* button_ui_part, + void UpdateButtonOnScreen(wxAuiDockUIPart* buttonUiPart, const wxMouseEvent& event); void GetPanePositionsAndSizes(wxAuiDockInfo& dock, wxArrayInt& positions, wxArrayInt& sizes); + /// Ends a resize action, or for live update, resizes the sash + bool DoEndResizeAction(wxMouseEvent& event); + + void SetActivePane(wxWindow* active_pane); public: @@ -576,6 +612,7 @@ 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); @@ -601,25 +638,31 @@ protected: wxAuiPaneInfoArray m_panes; // array of panes structures wxAuiDockInfoArray m_docks; // array of docks structures - wxAuiDockUIPartArray m_uiparts; // array of UI parts (captions, buttons, etc) + 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 - 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 + wxPoint m_actionStart; // position where the action click started + wxPoint m_actionOffset; // offset from upper left of the item clicked + wxAuiDockUIPart* m_actionPart; // ptr to the part the action happened to + wxWindow* m_actionWindow; // action frame or window (NULL if none) + wxRect m_actionHintRect; // hint rectangle for the action + wxRect m_lastRect; + wxAuiDockUIPart* m_hoverButton;// button uipart being hovered over + wxRect m_lastHint; // last hint rectangle + wxPoint m_lastMouseMove; // last mouse move position (see OnMotion) + int m_currentDragItem; 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) + bool m_hasMaximized; + + double m_dockConstraintX; // 0.0 .. 1.0; max pct of window width a dock can consume + double m_dockConstraintY; // 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 + wxFrame* m_hintWnd; // transparent hint window, if supported by platform + wxTimer m_hintFadeTimer; // transparent fade timer + wxByte m_hintFadeAmt; // transparent fade amount + wxByte m_hintFadeMax; // maximum value of hint fade + + void* m_reserved; #ifndef SWIG DECLARE_EVENT_TABLE() @@ -660,17 +703,17 @@ public: void SetPane(wxAuiPaneInfo* p) { pane = p; } void SetButton(int b) { button = b; } 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: wxAuiManager* manager; wxAuiPaneInfo* pane; @@ -699,6 +742,7 @@ public: resizable = true; fixed = false; toolbar = false; + reserved1 = false; } #ifndef SWIG @@ -714,6 +758,7 @@ public: toolbar = c.toolbar; panes = c.panes; rect = c.rect; + reserved1 = c.reserved1; } wxAuiDockInfo& operator=(const wxAuiDockInfo& c) @@ -728,16 +773,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 @@ -750,6 +796,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; }; @@ -789,21 +836,19 @@ public: #ifndef SWIG -// wx event machinery -BEGIN_DECLARE_EVENT_TYPES() - 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() +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_PANE_ACTIVATED, 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) + wxEVENT_HANDLER_CAST(wxAuiManagerEventFunction, func) #define EVT_AUI_PANE_BUTTON(func) \ wx__DECLARE_EVT0(wxEVT_AUI_PANE_BUTTON, wxAuiManagerEventHandler(func)) @@ -813,6 +858,8 @@ typedef void (wxEvtHandler::*wxAuiManagerEventFunction)(wxAuiManagerEvent&); 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_PANE_ACTIVATED(func) \ + wx__DECLARE_EVT0(wxEVT_AUI_PANE_ACTIVATED, wxAuiManagerEventHandler(func)) #define EVT_AUI_RENDER(func) \ wx__DECLARE_EVT0(wxEVT_AUI_RENDER, wxAuiManagerEventHandler(func)) #define EVT_AUI_FIND_MANAGER(func) \ @@ -824,6 +871,7 @@ typedef void (wxEvtHandler::*wxAuiManagerEventFunction)(wxAuiManagerEvent&); %constant wxEventType wxEVT_AUI_PANE_CLOSE; %constant wxEventType wxEVT_AUI_PANE_MAXIMIZE; %constant wxEventType wxEVT_AUI_PANE_RESTORE; +%constant wxEventType wxEVT_AUI_PANE_ACTIVATED; %constant wxEventType wxEVT_AUI_RENDER; %constant wxEventType wxEVT_AUI_FIND_MANAGER; @@ -832,6 +880,7 @@ typedef void (wxEvtHandler::*wxAuiManagerEventFunction)(wxAuiManagerEvent&); 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_PANE_ACTIVATED = wx.PyEventBinder( wxEVT_AUI_PANE_ACTIVATED ) EVT_AUI_RENDER = wx.PyEventBinder( wxEVT_AUI_RENDER ) EVT_AUI_FIND_MANAGER = wx.PyEventBinder( wxEVT_AUI_FIND_MANAGER ) }