remove C++ comment

[wxWidgets.git] / docs / latex / wx / auimanager.tex

diff --git a/docs/latex/wx/auimanager.tex b/docs/latex/wx/auimanager.tex
index 4cd604116f3277c76c5d8b1d768b293b1a9a2b5c..b522c9c2d965a7d85cb03a2944f1831bc55a1247 100644 (file)
--- a/docs/latex/wx/auimanager.tex
+++ b/docs/latex/wx/auimanager.tex
@@ -10,9 +10,9 @@ determine each pane's docking and floating behavior. 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 drawing is
 localized in one area, and may be customized depending on an
-applications' specific needs.
+application's specific needs.
 
-wxAuiManager works as follows: The programmer adds panes to the class,
+wxAuiManager works as follows: the programmer adds panes to the class,
 or makes changes to existing pane properties (dock position, floating
 state, show state, etc.). To apply these changes, wxAuiManager's
 Update() function is called. This batch processing can be used to avoid
@@ -48,19 +48,18 @@ Center. This is fairly self-explanatory. The pane will be placed in the
 location specified by this variable.
 
 {\bf Position:}
-More than one pane can be placed inside of a dock. Imagine to panes
+More than one pane can be placed inside of a dock. Imagine two panes
 being docked on the left side of a window. One pane can be placed over
 another. In proportionally managed docks, the pane position indicates
-it's sequential position, starting with zero. So, in our scenario with
+its sequential position, starting with zero. So, in our scenario with
 two panes docked on the left side, the top pane in the dock would have
 position 0, and the second one would occupy position 1.
 
 {\bf Row:}
 A row can allow for two docks to be placed next to each other. One of
 the most common places for this to happen is in the toolbar. Multiple
-toolbar rows are allowed, the first row being in row 0, and the second
-in row 1. Rows can also be used on vertically docked panes.
-
+toolbar rows are allowed, the first row being row 0, and the second
+row 1. Rows can also be used on vertically docked panes.
 
 {\bf Layer:}
 A layer is akin to an onion. Layer 0 is the very center of the
@@ -73,7 +72,8 @@ understand layers is by running the wxAUI sample.
 
 \wxheading{Derived from}
 
-\helpref{wxEvent}{wxevent}
+\helpref{wxEvtHandler}{wxevthandler}\\
+\helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 
@@ -126,7 +126,7 @@ enum wxAuiManagerOption
 
 \func{}{wxAuiManager}{\param{wxWindow* }{managed\_wnd = NULL}, \param{unsigned int }{flags = wxAUI\_MGR\_DEFAULT}}
 
-Constructor. \arg{frame} specifies the wxFrame which should be managed.
+Constructor. \arg{managed\_wnd} specifies the wxFrame which should be managed.
 \arg{flags}  specifies options which allow the frame management behavior
 to be modified.
 
@@ -167,6 +167,12 @@ Returns the current art provider being used.
 
 See also: \helpref{wxAuiDockArt}{wxauidockart}.
 
+\membersection{wxAuiManager::GetDockSizeConstraint}\label{wxauimanagergetdocksizeconstraint}
+
+\func{void}{GetDockSizeConstraint}{\param{double* }{widthpct}, \param{double* }{heightpct}}
+
+Returns the current dock constraint values.  See \helpref{SetDockSizeConstraint()}{wxauimanagersetdocksizeconstraint} for more information.
+
 \membersection{wxAuiManager::GetFlags}\label{wxauimanagergetflags}
 
 \constfunc{unsigned int}{GetFlags}{\void}
@@ -179,6 +185,16 @@ Returns the current manager's flags.
 
 Returns the frame currently being managed by wxAuiManager.
 
+\membersection{wxAuiManager::GetManager}\label{wxauimanagergetmanager}
+
+\func{static wxAuiManager*}{GetManager}{\param{wxWindow* }{window}}
+
+Calling this method will return the wxAuiManager for a given window.  The \arg{window} parameter should
+specify any child window or sub-child window of the frame or window managed by wxAuiManager.
+The \arg{window} parameter need not be managed by the manager itself, nor does it even need to be a child
+or sub-child of a managed window.  It must however be inside the window hierarchy underneath the managed
+window.
+
 \membersection{wxAuiManager::GetPane}\label{wxauimanagergetpane}
 
 \func{wxAuiPaneInfo\&}{GetPane}{\param{wxWindow* }{window}}
@@ -258,6 +274,17 @@ will be deleted by wxAuiManager.
 
 See also: \helpref{wxAuiDockArt}{wxauidockart}.
 
+\membersection{wxAuiManager::SetDockSizeConstraint}\label{wxauimanagersetdocksizeconstraint}
+
+\func{void}{SetDockSizeConstraint}{\param{double }{widthpct}, \param{double }{heightpct}}
+
+When a user creates a new dock by dragging a window into a docked position, often times the large size of the
+window will create a dock that is unwieldly large.  wxAuiManager by default limits the size of any
+new dock to 1/3 of the window size.  For horizontal docks, this would be 1/3 of the window height.  For
+vertical docks, 1/3 of the width.  Calling this function will adjust this constraint value.  The numbers
+must be between 0.0 and 1.0.  For instance, calling SetDockSizeContraint with 0.5, 0.5 will cause new
+docks to be limited to half of the size of the entire managed window. 
+
 \membersection{wxAuiManager::SetFlags}\label{wxauimanagersetflags}
 
 \func{void}{SetFlags}{\param{unsigned int }{flags}}