Better name for wxXmlResource::GetDirection() argument.

[wxWidgets.git] / interface / wx / aui / framemanager.h

diff --git a/interface/wx/aui/framemanager.h b/interface/wx/aui/framemanager.h
index f67783ab48990ceb7dc2cc9f3d41a54423f2416e..68854534ebb5f4adec21050d33dc1dc863edb007 100644 (file)
--- a/interface/wx/aui/framemanager.h
+++ b/interface/wx/aui/framemanager.h
@@ -2,7 +2,6 @@
 // Name:        aui/aui.h
 // Purpose:     interface of wxAuiManager
 // Author:      wxWidgets team
 // Name:        aui/aui.h
 // Purpose:     interface of wxAuiManager
 // Author:      wxWidgets team

-// RCS-ID:      $Id$

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 


@@ -23,20 +22,31 @@ enum wxAuiManagerDock
 
 
 /**
 
 
 /**

-    @todo wxAuiManager behavior style flags.
+    wxAuiManager behaviour and visual effects style flags.

 */
 enum wxAuiManagerOption
 {
 */
 enum wxAuiManagerOption
 {

+    /// Allow a pane to be undocked to take the form of a wxMiniFrame.

     wxAUI_MGR_ALLOW_FLOATING           = 1 << 0,
     wxAUI_MGR_ALLOW_FLOATING           = 1 << 0,

+    /// Change the color of the title bar of the pane when it is activated.

     wxAUI_MGR_ALLOW_ACTIVE_PANE        = 1 << 1,
     wxAUI_MGR_ALLOW_ACTIVE_PANE        = 1 << 1,

+    /// Make the pane transparent during its movement.

     wxAUI_MGR_TRANSPARENT_DRAG         = 1 << 2,
     wxAUI_MGR_TRANSPARENT_DRAG         = 1 << 2,

+    /// The possible location for docking is indicated by a translucent area.

     wxAUI_MGR_TRANSPARENT_HINT         = 1 << 3,
     wxAUI_MGR_TRANSPARENT_HINT         = 1 << 3,

+    /// The possible location for docking is indicated by a gradually appearing
+    /// partially transparent area.

     wxAUI_MGR_VENETIAN_BLINDS_HINT     = 1 << 4,
     wxAUI_MGR_VENETIAN_BLINDS_HINT     = 1 << 4,

+    /// The possible location for docking is indicated by a rectangular outline.

     wxAUI_MGR_RECTANGLE_HINT           = 1 << 5,
     wxAUI_MGR_RECTANGLE_HINT           = 1 << 5,

+    /// The translucent area where the pane could be docked appears gradually.

     wxAUI_MGR_HINT_FADE                = 1 << 6,
     wxAUI_MGR_HINT_FADE                = 1 << 6,

+    /// Used in complement of wxAUI_MGR_VENETIAN_BLINDS_HINT to show the hint immediately.

     wxAUI_MGR_NO_VENETIAN_BLINDS_FADE  = 1 << 7,
     wxAUI_MGR_NO_VENETIAN_BLINDS_FADE  = 1 << 7,

+    /// When a docked pane is resized, its content is refreshed in live (instead of moving
+    /// the border alone and refreshing the content at the end).

     wxAUI_MGR_LIVE_RESIZE              = 1 << 8,
     wxAUI_MGR_LIVE_RESIZE              = 1 << 8,

-
+    /// Default behavior.

     wxAUI_MGR_DEFAULT = wxAUI_MGR_ALLOW_FLOATING |
                         wxAUI_MGR_TRANSPARENT_HINT |
                         wxAUI_MGR_HINT_FADE |
     wxAUI_MGR_DEFAULT = wxAUI_MGR_ALLOW_FLOATING |
                         wxAUI_MGR_TRANSPARENT_HINT |
                         wxAUI_MGR_HINT_FADE |


@@ -50,7 +60,7 @@ enum wxAuiManagerOption
 
     wxAuiManager manages the panes associated with it for a particular wxFrame,
     using a pane's wxAuiPaneInfo information to determine each pane's docking
 
     wxAuiManager manages the panes associated with it for a particular wxFrame,
     using a pane's wxAuiPaneInfo information to determine each pane's docking

-    and floating behavior.
+    and floating behaviour.

 
     wxAuiManager uses wxWidgets' sizer mechanism to plan the layout of each
     frame. It uses a replaceable dock art class to do all drawing, so all
 
     wxAuiManager uses wxWidgets' sizer mechanism to plan the layout of each
     frame. It uses a replaceable dock art class to do all drawing, so all


@@ -110,6 +120,33 @@ enum wxAuiManagerOption
         in a lower level yield to panes in higher levels. The best way to
         understand layers is by running the wxAUI sample.
 
         in a lower level yield to panes in higher levels. The best way to
         understand layers is by running the wxAUI sample.
 

+    @beginStyleTable
+    @style{wxAUI_MGR_ALLOW_FLOATING}
+           Allow a pane to be undocked to take the form of a wxMiniFrame.
+    @style{wxAUI_MGR_ALLOW_ACTIVE_PANE}
+           Change the color of the title bar of the pane when it is activated.
+    @style{wxAUI_MGR_TRANSPARENT_DRAG}
+           Make the pane transparent during its movement.
+    @style{wxAUI_MGR_TRANSPARENT_HINT}
+           The possible location for docking is indicated by a translucent area.
+    @style{wxAUI_MGR_VENETIAN_BLINDS_HINT}
+           The possible location for docking is indicated by gradually
+           appearing partially transparent hint.
+    @style{wxAUI_MGR_RECTANGLE_HINT}
+           The possible location for docking is indicated by a rectangular
+           outline.
+    @style{wxAUI_MGR_HINT_FADE}
+           The translucent area where the pane could be docked appears gradually.
+    @style{wxAUI_MGR_NO_VENETIAN_BLINDS_FADE}
+           Used in complement of wxAUI_MGR_VENETIAN_BLINDS_HINT to show the
+           docking hint immediately.
+    @style{wxAUI_MGR_LIVE_RESIZE}
+           When a docked pane is resized, its content is refreshed in live (instead of moving
+           the border alone and refreshing the content at the end).
+    @style{wxAUI_MGR_DEFAULT}
+           Default behavior, combines: wxAUI_MGR_ALLOW_FLOATING | wxAUI_MGR_TRANSPARENT_HINT |
+           wxAUI_MGR_HINT_FADE | wxAUI_MGR_NO_VENETIAN_BLINDS_FADE.
+    @endStyleTable

 
     @beginEventEmissionTable{wxAuiManagerEvent}
     @event{EVT_AUI_PANE_BUTTON(func)}
 
     @beginEventEmissionTable{wxAuiManagerEvent}
     @event{EVT_AUI_PANE_BUTTON(func)}


@@ -120,12 +157,15 @@ enum wxAuiManagerOption
         Triggered when a pane is maximized.
     @event{EVT_AUI_PANE_RESTORE(func)}
         Triggered when a pane is restored.
         Triggered when a pane is maximized.
     @event{EVT_AUI_PANE_RESTORE(func)}
         Triggered when a pane is restored.

+    @event{EVT_AUI_PANE_ACTIVATED(func)}
+        Triggered when a pane is made 'active'. This event is new since
+        wxWidgets 2.9.4.

     @event{EVT_AUI_RENDER(func)}
         This event can be caught to override the default renderer in order to
         custom draw your wxAuiManager window (not recommended).
     @endEventTable
 
     @event{EVT_AUI_RENDER(func)}
         This event can be caught to override the default renderer in order to
         custom draw your wxAuiManager window (not recommended).
     @endEventTable
 

-    @library{wxbase}
+    @library{wxaui}

     @category{aui}
 
     @see @ref overview_aui, wxAuiNotebook, wxAuiDockArt, wxAuiPaneInfo
     @category{aui}
 
     @see @ref overview_aui, wxAuiNotebook, wxAuiDockArt, wxAuiPaneInfo


@@ -134,9 +174,13 @@ class wxAuiManager : public wxEvtHandler
 {
 public:
     /**
 {
 public:
     /**

-        Constructor. @a managed_wnd specifies the wxFrame which should be managed.
-        @a flags  specifies options which allow the frame management behavior
-        to be modified.
+        Constructor.
+
+        @param managed_wnd
+            Specifies the wxFrame which should be managed.
+        @param flags
+            Specifies the frame management behaviour and visual effects
+            with the ::wxAuiManagerOption's style flags.

     */
     wxAuiManager(wxWindow* managed_wnd = NULL,
                  unsigned int flags = wxAUI_MGR_DEFAULT);
     */
     wxAuiManager(wxWindow* managed_wnd = NULL,
                  unsigned int flags = wxAUI_MGR_DEFAULT);


@@ -188,7 +232,7 @@ public:
     void GetDockSizeConstraint(double* widthpct, double* heightpct) const;
 
     /**
     void GetDockSizeConstraint(double* widthpct, double* heightpct) const;
 
     /**

-        Returns the current manager's flags.
+        Returns the current ::wxAuiManagerOption's flags.

     */
     unsigned int GetFlags() const;
 
     */
     unsigned int GetFlags() const;
 


@@ -298,8 +342,8 @@ public:
     void SetDockSizeConstraint(double widthpct, double heightpct);
 
     /**
     void SetDockSizeConstraint(double widthpct, double heightpct);
 
     /**

-        This method is used to specify wxAuiManager's settings flags. @a flags
-        specifies options which allow the frame management behavior to be modified.
+        This method is used to specify ::wxAuiManagerOption's flags. @a flags
+        specifies options which allow the frame management behaviour to be modified.

     */
     void SetFlags(unsigned int flags);
 
     */
     void SetFlags(unsigned int flags);
 


@@ -362,7 +406,7 @@ protected:
     In addition, these parameters specify the pane's docked position, floating
     position, preferred size, minimum size, caption text among many other parameters.
 
     In addition, these parameters specify the pane's docked position, floating
     position, preferred size, minimum size, caption text among many other parameters.
 

-    @library{wxbase}
+    @library{wxaui}

     @category{aui}
 
     @see wxAuiManager, wxAuiDockArt
     @category{aui}
 
     @see wxAuiManager, wxAuiDockArt


@@ -830,11 +874,14 @@ public:
         Triggered when a pane is maximized.
     @event{EVT_AUI_PANE_RESTORE(func)}
         Triggered when a pane is restored.
         Triggered when a pane is maximized.
     @event{EVT_AUI_PANE_RESTORE(func)}
         Triggered when a pane is restored.

+    @event{EVT_AUI_PANE_ACTIVATED(func)}
+        Triggered when a pane is made 'active'. This event is new since
+        wxWidgets 2.9.4.

     @event{EVT_AUI_RENDER(func)}
         This event can be caught to override the default renderer in order to
         custom draw your wxAuiManager window (not recommended).
     @endEventTable
     @event{EVT_AUI_RENDER(func)}
         This event can be caught to override the default renderer in order to
         custom draw your wxAuiManager window (not recommended).
     @endEventTable

-    
+

     @library{wxaui}
     @category{events,aui}
 
     @library{wxaui}
     @category{events,aui}