]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/aui/framemanager.h
don't do anything in SetWindowMenu() if we're setting the same menu as we already...
[wxWidgets.git] / include / wx / aui / framemanager.h
index 201768dccc05305e24fc81dc85479ade77bbcc07..056feb56b6427128d82ec2c866cb04301ac7d338 100644 (file)
@@ -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 |
@@ -166,7 +167,7 @@ public:
     }
 
     ~wxAuiPaneInfo() {}
-    
+
 #ifndef SWIG
     wxAuiPaneInfo(const wxAuiPaneInfo& c)
     {
@@ -225,7 +226,7 @@ public:
         *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); }
@@ -298,9 +299,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)
     {
@@ -333,26 +332,32 @@ public:
         return *this;
     }
 
-    wxAuiPaneInfo& SetFlag(unsigned int flag, bool option_state)
+    wxAuiPaneInfo& SetFlag(int flag, bool option_state)
     {
         if (option_state)
             state |= flag;
-             else
+        else
             state &= ~flag;
         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,
@@ -372,15 +377,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
     };
 
@@ -412,11 +420,11 @@ public:
 
 
 
-class WXDLLIMPEXP_AUI wxAuiFloatingFrame;
+class WXDLLIMPEXP_FWD_AUI wxAuiFloatingFrame;
 
 class WXDLLIMPEXP_AUI wxAuiManager : public wxEvtHandler
 {
-friend class wxAuiFloatingFrame;
+    friend class wxAuiFloatingFrame;
 
 public:
 
@@ -433,9 +441,6 @@ public:
 
     static wxAuiManager* GetManager(wxWindow* window);
 
-#ifdef SWIG
-    %disownarg( wxAuiDockArt* art_provider );
-#endif
     void SetArtProvider(wxAuiDockArt* art_provider);
     wxAuiDockArt* GetArtProvider() const;
 
@@ -445,7 +450,7 @@ public:
 
     bool AddPane(wxWindow* window,
                  const wxAuiPaneInfo& pane_info);
-                 
+
     bool AddPane(wxWindow* window,
                  const wxAuiPaneInfo& pane_info,
                  const wxPoint& drop_pos);
@@ -459,48 +464,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 SetDockSizeConstraint(double width_pct, double height_pct);
+    void GetDockSizeConstraint(double* width_pct, double* height_pct) const;
 
-    void Update();
+    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,
@@ -528,8 +543,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);
@@ -548,6 +561,8 @@ protected:
                               wxArrayInt& positions,
                               wxArrayInt& sizes);
 
+    /// Ends a resize action, or for live update, resizes the sash
+    bool DoEndResizeAction(wxMouseEvent& event);
 
 public:
 
@@ -565,6 +580,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);
@@ -598,18 +614,24 @@ 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)
@@ -649,17 +671,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;
@@ -688,6 +710,7 @@ public:
         resizable = true;
         fixed = false;
         toolbar = false;
+        reserved1 = false;
     }
 
 #ifndef SWIG
@@ -703,6 +726,7 @@ public:
         toolbar = c.toolbar;
         panes = c.panes;
         rect = c.rect;
+        reserved1 = c.reserved1;
     }
 
     wxAuiDockInfo& operator=(const wxAuiDockInfo& c)
@@ -717,16 +741,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
@@ -739,6 +764,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;
 };
 
 
@@ -778,51 +804,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)
-    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_FINDMANAGER, 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_FINDMANAGER(func) \
-   wx__DECLARE_EVT0(wxEVT_AUI_FINDMANAGER, 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_FINDMANAGER;
+%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_FINDMANAGER = wx.PyEventBinder( wxEVT_AUI_FINDMANAGER )
+    EVT_AUI_FIND_MANAGER = wx.PyEventBinder( wxEVT_AUI_FIND_MANAGER )
 }
 #endif // SWIG