]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/aui/framemanager.h
removed wx/wave.h which was deprecated since 2.4
[wxWidgets.git] / include / wx / aui / framemanager.h
index 84fc2bddf828de1ac7e95beb56a352989148ddd9..2e56f30851d3cd15362eed07699f1abc6ff7fbc9 100644 (file)
@@ -57,23 +57,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 +89,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
@@ -298,9 +299,6 @@ public:
     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& Dockable(bool b = true)
     {
         return TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b);
@@ -352,6 +350,12 @@ public:
     
 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 +375,17 @@ 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,
+
+        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
     };
 
@@ -430,6 +436,8 @@ public:
     void SetManagedWindow(wxWindow* managed_wnd);
     wxWindow* GetManagedWindow() const;
 
+    static wxAuiManager* GetManager(wxWindow* window);
+
 #ifdef SWIG
     %disownarg( wxAuiDockArt* art_provider );
 #endif
@@ -457,28 +465,39 @@ public:
 
     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);
 
-    void DrawHintRect(wxWindow* pane_window,
-                      const wxPoint& pt,
-                      const wxPoint& offset);
+    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();
 
@@ -521,8 +540,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);
@@ -561,6 +578,7 @@ protected:
     void OnLeaveWindow(wxMouseEvent& evt);
     void OnChildFocus(wxChildFocusEvent& evt);
     void OnHintFadeTimer(wxTimerEvent& evt);
+    void OnFindManager(wxAuiManagerEvent& evt);
 
 protected:
 
@@ -590,20 +608,26 @@ 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)
+    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
 };
 
@@ -616,6 +640,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;
@@ -625,6 +650,7 @@ public:
 #ifndef SWIG
     wxAuiManagerEvent(const wxAuiManagerEvent& c) : wxEvent(c)
     {
+        manager = c.manager;
         pane = c.pane;
         button = c.button;
         veto_flag = c.veto_flag;
@@ -634,13 +660,15 @@ 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; }
@@ -648,6 +676,7 @@ public:
     bool CanVeto() const { return  canveto_flag && veto_flag; }
     
 public:
+    wxAuiManager* manager;
     wxAuiPaneInfo* pane;
     int button;
     bool veto_flag;
@@ -674,6 +703,7 @@ public:
         resizable = true;
         fixed = false;
         toolbar = false;
+        reserved1 = false;
     }
 
 #ifndef SWIG
@@ -689,6 +719,7 @@ public:
         toolbar = c.toolbar;
         panes = c.panes;
         rect = c.rect;
+        reserved1 = c.reserved1;
     }
 
     wxAuiDockInfo& operator=(const wxAuiDockInfo& c)
@@ -703,6 +734,7 @@ public:
         toolbar = c.toolbar;
         panes = c.panes;
         rect = c.rect;
+        reserved1 = c.reserved1;
         return *this;
     }
 #endif // SWIG
@@ -725,6 +757,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;
 };
 
 
@@ -767,11 +800,12 @@ public:
 // 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_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::*wxAuiManagerEventFunction)(wxAuiManagerEvent&);
@@ -779,31 +813,35 @@ 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))
+#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