From e67635d4ee0e52e785cd7db08b3981b58eaabb9d Mon Sep 17 00:00:00 2001
From: Robert Roebling <robert@roebling.de>
Date: Sat, 4 Nov 2006 21:38:52 +0000
Subject: [PATCH]   Renamed AUI tex files.   Documented wxAuiDockArt.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@43069 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/auidockart.tex  | 206 +++++++++++++++
 docs/latex/wx/auimanager.tex  | 297 +++++++++++++++++++++
 docs/latex/wx/auipaneinfo.tex | 477 ++++++++++++++++++++++++++++++++++
 3 files changed, 980 insertions(+)
 create mode 100644 docs/latex/wx/auidockart.tex
 create mode 100644 docs/latex/wx/auimanager.tex
 create mode 100644 docs/latex/wx/auipaneinfo.tex

diff --git a/docs/latex/wx/auidockart.tex b/docs/latex/wx/auidockart.tex
new file mode 100644
index 0000000000..d9e9440d3d
--- /dev/null
+++ b/docs/latex/wx/auidockart.tex
@@ -0,0 +1,206 @@
+%
+% automatically generated by HelpGen $Revision$ from
+% dockart.h at 04/Nov/06 21:54:42
+%
+
+\section{\class{wxAuiDockArt}}\label{wxauidockart}
+
+Dock art provider code - a dock provider provides all drawing
+functionality to the wxAui dock manager. This allows the dock
+manager to have a plugable look-and-feel.
+
+By default, a \helpref{wxAuiManager}{wxauimanager} uses an
+instance of this class called {\bf wxAuiDefaultDockArt} which
+provides bitmap art and a colour scheme that is adapted to
+the major platforms' look. You can either derive from that
+class to alter its behaviour or write a completely new dock
+art class. Call \helpref{wxAuiManager::SetArtProvider}{wxauimanagersetartprovider}
+to make use this new dock art.
+
+\wxheading{Derived from}
+
+No base class
+
+\wxheading{Include files}
+
+<wx/aui/dockart.h>
+
+\wxheading{See also}
+
+\helpref{wxAuiManager}{wxauimanager},
+\helpref{wxAuiPaneInfo}{wxauipaneinfo}
+
+\wxheading{Data structures}
+
+\begin{verbatim}
+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
+}
+\end{verbatim}
+
+\begin{verbatim}
+enum wxAuiPaneDockArtGradients
+{
+    wxAUI_GRADIENT_NONE = 0,
+    wxAUI_GRADIENT_VERTICAL = 1,
+    wxAUI_GRADIENT_HORIZONTAL = 2
+}
+\end{verbatim}
+
+\begin{verbatim}
+enum wxAuiPaneButtonState
+{
+    wxAUI_BUTTON_STATE_NORMAL = 0,
+    wxAUI_BUTTON_STATE_HOVER = 1,
+    wxAUI_BUTTON_STATE_PRESSED = 2
+}
+\end{verbatim}
+
+\begin{verbatim}
+enum wxAuiButtonId
+{
+    wxAUI_BUTTON_CLOSE = 101,
+    wxAUI_BUTTON_MAXIMIZE_RESTORE = 102,
+    wxAUI_BUTTON_MINIMIZE = 103,
+    wxAUI_BUTTON_PIN = 104,
+    wxAUI_BUTTON_OPTIONS = 105,
+    wxAUI_BUTTON_WINDOWLIST = 106,
+    wxAUI_BUTTON_LEFT = 107,
+    wxAUI_BUTTON_RIGHT = 108,
+    wxAUI_BUTTON_UP = 109,
+    wxAUI_BUTTON_DOWN = 110,
+    wxAUI_BUTTON_CUSTOM1 = 201,
+    wxAUI_BUTTON_CUSTOM2 = 202,
+    wxAUI_BUTTON_CUSTOM3 = 203
+};
+\end{verbatim}
+
+
+
+\membersection{wxAuiDockArt::wxAuiDockArt}\label{wxauidockartwxauidockart}
+
+\func{}{wxAuiDockArt}{\void}
+
+Constructor.
+
+\membersection{wxAuiDockArt::\destruct{wxAuiDockArt}}\label{wxauidockartdtor}
+
+\func{}{\destruct{wxAuiDockArt}}{\void}
+
+Destructor.
+
+\membersection{wxAuiDockArt::DrawBackground}\label{wxauidockartdrawbackground}
+
+\func{virtual void}{DrawBackground}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{int }{orientation}, \param{const wxRect\& }{rect}}
+
+Draws a background.
+
+\membersection{wxAuiDockArt::DrawBorder}\label{wxauidockartdrawborder}
+
+\func{virtual void}{DrawBorder}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}
+
+Draws a border.
+
+\membersection{wxAuiDockArt::DrawCaption}\label{wxauidockartdrawcaption}
+
+\func{virtual void}{DrawCaption}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{const wxString\& }{text}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}
+
+Draws a caption.
+
+\membersection{wxAuiDockArt::DrawGripper}\label{wxauidockartdrawgripper}
+
+\func{virtual void}{DrawGripper}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}
+
+Draws a gripper.
+
+\membersection{wxAuiDockArt::DrawPaneButton}\label{wxauidockartdrawpanebutton}
+
+\func{virtual void}{DrawPaneButton}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{int }{button}, \param{int }{button\_state}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}
+
+Draws a button in the pane's title bar.
+
+{\it button} can be one of the values of {\bf wxAuiButtonId}.
+
+{\it button\_state} can be one of the values of {\bf wxAuiPaneButtonState}.
+
+\membersection{wxAuiDockArt::DrawSash}\label{wxauidockartdrawsash}
+
+\func{virtual void}{DrawSash}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{int }{orientation}, \param{const wxRect\& }{rect}}
+
+Draws a sash between two windows.
+
+\membersection{wxAuiDockArt::GetColor}\label{wxauidockartgetcolor}
+
+\func{virtual wxColour}{GetColor}{\param{int }{id}}
+
+The same as \helpref{GetColour}{wxauidockartgetcolour}.
+
+\membersection{wxAuiDockArt::GetColour}\label{wxauidockartgetcolour}
+
+\func{virtual wxColour}{GetColour}{\param{int }{id}}
+
+Get the colour of a certain setting.
+
+{\it id} can be one of the colour values of {\bf wxAuiPaneDockArtSetting}.
+
+
+\membersection{wxAuiDockArt::GetFont}\label{wxauidockartgetfont}
+
+\func{virtual wxFont}{GetFont}{\param{int }{id}}
+
+Get a font setting.
+
+\membersection{wxAuiDockArt::GetMetric}\label{wxauidockartgetmetric}
+
+\func{virtual int}{GetMetric}{\param{int }{id}}
+
+Get the value of a certain setting.
+
+{\it id} can be one of the size values of {\bf wxAuiPaneDockArtSetting}.
+
+
+\membersection{wxAuiDockArt::SetColor}\label{wxauidockartsetcolor}
+
+\func{virtual void}{SetColor}{\param{int }{id}, \param{const wxColour\& }{color}}
+
+The same as \helpref{SetColour}{wxauidockartsetcolour}.
+
+\membersection{wxAuiDockArt::SetColour}\label{wxauidockartsetcolour}
+
+\func{virtual void}{SetColour}{\param{int }{id}, \param{const wxColor\& }{colour}}
+
+Set a certain setting with the value {\it colour}.
+
+{\it id} can be one of the colour values of {\bf wxAuiPaneDockArtSetting}.
+
+\membersection{wxAuiDockArt::SetFont}\label{wxauidockartsetfont}
+
+\func{virtual void}{SetFont}{\param{int }{id}, \param{const wxFont\& }{font}}
+
+Set a font setting.
+
+\membersection{wxAuiDockArt::SetMetric}\label{wxauidockartsetmetric}
+
+\func{virtual void}{SetMetric}{\param{int }{id}, \param{int }{new\_val}}
+
+Set a certain setting with the value {\it new\_val}.
+
+{\it id} can be one of the size values of {\bf wxAuiPaneDockArtSetting}.
+
diff --git a/docs/latex/wx/auimanager.tex b/docs/latex/wx/auimanager.tex
new file mode 100644
index 0000000000..4cd604116f
--- /dev/null
+++ b/docs/latex/wx/auimanager.tex
@@ -0,0 +1,297 @@
+\section{\class{wxAuiManager}}\label{wxauimanager}
+
+wxAuiManager is the central class of the wxAUI class framework.
+
+See also \helpref{wxAUI overview}{wxauioverview}.
+
+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. 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.
+
+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
+flicker, by modifying more than one pane at a time, and then "committing"
+all of the changes at once by calling Update().
+
+Panes can be added quite easily:
+
+\begin{verbatim}
+wxTextCtrl* text1 = new wxTextCtrl(this, -1);
+wxTextCtrl* text2 = new wxTextCtrl(this, -1);
+m_mgr.AddPane(text1, wxLEFT, wxT("Pane Caption"));
+m_mgr.AddPane(text2, wxBOTTOM, wxT("Pane Caption"));
+m_mgr.Update();
+\end{verbatim}
+
+Later on, the positions can be modified easily. The following will float
+an existing pane in a tool window:
+
+\begin{verbatim}
+m_mgr.GetPane(text1).Float();
+\end{verbatim}
+
+\wxheading{Layers, Rows and Directions, Positions}
+
+Inside wxAUI, the docking layout is figured out by checking several
+pane parameters. Four of these are important for determining where a
+pane will end up:
+
+{\bf Direction:}
+Each docked pane has a direction, Top, Bottom, Left, Right, or
+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
+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
+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.
+
+
+{\bf Layer:}
+A layer is akin to an onion. Layer 0 is the very center of the
+managed pane. Thus, if a pane is in layer 0, it will be closest to the
+center window (also sometimes known as the "content window").
+Increasing layers "swallow up" all layers of a lower value. This can
+look very similar to multiple rows, but is different because all panes
+in a lower level yield to panes in higher levels. The best way to
+understand layers is by running the wxAUI sample.
+
+\wxheading{Derived from}
+
+\helpref{wxEvent}{wxevent}
+
+\wxheading{Include files}
+
+<wx/aui/aui.h>
+
+\wxheading{See also}
+
+\helpref{wxAuiPaneInfo}{wxauipaneinfo},
+\helpref{wxAuiDockArt}{wxauidockart}
+
+\wxheading{Data structures}
+
+\begin{verbatim}
+enum wxAuiManagerDock
+{
+    wxAUI_DOCK_NONE = 0,
+    wxAUI_DOCK_TOP = 1,
+    wxAUI_DOCK_RIGHT = 2,
+    wxAUI_DOCK_BOTTOM = 3,
+    wxAUI_DOCK_LEFT = 4,
+    wxAUI_DOCK_CENTER = 5,
+    wxAUI_DOCK_CENTRE = wxAUI_DOCK_CENTER
+}
+\end{verbatim}
+
+\begin{verbatim}
+enum wxAuiManagerOption
+{
+    wxAUI_MGR_ALLOW_FLOATING           = 1 << 0,
+    wxAUI_MGR_ALLOW_ACTIVE_PANE        = 1 << 1,
+    wxAUI_MGR_TRANSPARENT_DRAG         = 1 << 2,
+    wxAUI_MGR_TRANSPARENT_HINT         = 1 << 3,
+    wxAUI_MGR_VENETIAN_BLINDS_HINT     = 1 << 4,
+    wxAUI_MGR_RECTANGLE_HINT           = 1 << 5,
+    wxAUI_MGR_HINT_FADE                = 1 << 6,
+    wxAUI_MGR_NO_VENETIAN_BLINDS_FADE  = 1 << 7,
+
+    wxAUI_MGR_DEFAULT = wxAUI_MGR_ALLOW_FLOATING |
+                        wxAUI_MGR_TRANSPARENT_HINT |
+                        wxAUI_MGR_HINT_FADE |
+                        wxAUI_MGR_NO_VENETIAN_BLINDS_FADE
+}
+\end{verbatim}
+
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxAuiManager::wxAuiManager}\label{wxauimanagerwxauimanager}
+
+\func{}{wxAuiManager}{\param{wxWindow* }{managed\_wnd = NULL}, \param{unsigned int }{flags = wxAUI\_MGR\_DEFAULT}}
+
+Constructor. \arg{frame} specifies the wxFrame which should be managed.
+\arg{flags}  specifies options which allow the frame management behavior
+to be modified.
+
+\membersection{wxAuiManager::\destruct{wxAuiManager}}\label{wxauimanagerdtor}
+
+\func{}{\destruct{wxAuiManager}}{\void}
+
+\membersection{wxAuiManager::AddPane}\label{wxauimanageraddpane}
+
+\func{bool}{AddPane}{\param{wxWindow* }{window}, \param{const wxAuiPaneInfo\& }{pane\_info}}
+
+\func{bool}{AddPane}{\param{wxWindow* }{window}, \param{int }{direction = wxLEFT}, \param{const wxString\& }{caption = wxEmptyString}}
+
+\func{bool}{AddPane}{\param{wxWindow* }{window}, \param{const wxAuiPaneInfo\& }{pane\_info}, \param{const wxPoint\& }{drop\_pos}}
+
+
+AddPane() tells the frame manager to start managing a child window. There are several versions of this function. The first version allows the full spectrum of pane parameter possibilities. The second version is used for simpler user interfaces which do not require as much configuration.  The last version allows a drop position to be specified, which will determine where the pane will be added.
+
+\membersection{wxAuiManager::DetachPane}\label{wxauimanagerdetachpane}
+
+\func{bool}{DetachPane}{\param{wxWindow* }{window}}
+
+Tells the wxAuiManager to stop managing the pane specified by window.
+The window, if in a floated frame, is reparented to the frame managed
+by wxAuiManager.
+
+\membersection{wxAuiManager::GetAllPanes}\label{wxauimanagergetallpanes}
+
+\func{wxAuiPaneInfoArray\&}{GetAllPanes}{\void}
+
+Returns an array of all panes managed by the frame manager.
+
+\membersection{wxAuiManager::GetArtProvider}\label{wxauimanagergetartprovider}
+
+\constfunc{wxAuiDockArt*}{GetArtProvider}{\void}
+
+Returns the current art provider being used.
+
+See also: \helpref{wxAuiDockArt}{wxauidockart}.
+
+\membersection{wxAuiManager::GetFlags}\label{wxauimanagergetflags}
+
+\constfunc{unsigned int}{GetFlags}{\void}
+
+Returns the current manager's flags.
+
+\membersection{wxAuiManager::GetManagedWindow}\label{wxauimanagergetmanagedwindow}
+
+\constfunc{wxWindow*}{GetManagedWindow}{\void}
+
+Returns the frame currently being managed by wxAuiManager.
+
+\membersection{wxAuiManager::GetPane}\label{wxauimanagergetpane}
+
+\func{wxAuiPaneInfo\&}{GetPane}{\param{wxWindow* }{window}}
+
+\func{wxAuiPaneInfo\&}{GetPane}{\param{const wxString\& }{name}}
+
+{\it GetPane} is used to lookup a wxAuiPaneInfo object
+either by window pointer or by pane name, which acts as a unique id for
+a window pane. The returned wxAuiPaneInfo object may then be modified to
+change a pane's look, state or position. After one or more
+modifications to wxAuiPaneInfo, wxAuiManager::Update() should be called
+to commit the changes to the user interface. If the lookup failed
+(meaning the pane could not be found in the manager), a call to the
+returned wxAuiPaneInfo's IsOk() method will return false.
+
+\membersection{wxAuiManager::HideHint}\label{wxauimanagerhidehint}
+
+\func{void}{HideHint}{\void}
+
+HideHint() hides any docking hint that may be visible.
+
+\membersection{wxAuiManager::InsertPane}\label{wxauimanagerinsertpane}
+
+\func{bool}{InsertPane}{\param{wxWindow* }{window}, \param{const wxAuiPaneInfo\& }{insert\_location}, \param{int }{insert\_level = wxAUI\_INSERT\_PANE}}
+
+This method is used to insert either a previously unmanaged pane window
+into the frame manager, or to insert a currently managed pane somewhere 
+else. {\it InsertPane} will push all panes, rows, or docks aside and
+insert the window into the position specified by \arg{insert\_location}. 
+Because \arg{insert\_location} can specify either a pane, dock row, or dock
+layer, the \arg{insert\_level} parameter is used to disambiguate this. The
+parameter \arg{insert\_level} can take a value of wxAUI\_INSERT\_PANE, wxAUI\_INSERT\_ROW 
+or wxAUI\_INSERT\_DOCK.
+
+\membersection{wxAuiManager::LoadPaneInfo}\label{wxauimanagerloadpaneinfo}
+
+\func{void}{LoadPaneInfo}{\param{wxString }{pane\_part}, \param{wxAuiPaneInfo\& }{pane}}
+
+LoadPaneInfo() is similar to to LoadPerspective, with the exception that it only loads information about a single pane.  It is used in combination with SavePaneInfo().
+
+\membersection{wxAuiManager::LoadPerspective}\label{wxauimanagerloadperspective}
+
+\func{bool}{LoadPerspective}{\param{const wxString\& }{perspective}, \param{bool }{update = true}}
+
+Loads a saved perspective. If update is true, wxAuiManager::Update()
+is automatically invoked, thus realizing the saved perspective on screen.
+
+\membersection{wxAuiManager::ProcessDockResult}\label{wxauimanagerprocessdockresult}
+
+\func{bool}{ProcessDockResult}{\param{wxAuiPaneInfo\& }{target}, \param{const wxAuiPaneInfo\& }{new\_pos}}
+
+ProcessDockResult() is a protected member of the wxAUI layout manager.  It can be overridden by derived classes to provide custom docking calculations.
+
+\membersection{wxAuiManager::SavePaneInfo}\label{wxauimanagersavepaneinfo}
+
+\func{wxString}{SavePaneInfo}{\param{wxAuiPaneInfo\& }{pane}}
+
+SavePaneInfo() is similar to SavePerspective, with the exception that it only saves information about a single pane.  It is used in combination with LoadPaneInfo().
+
+\membersection{wxAuiManager::SavePerspective}\label{wxauimanagersaveperspective}
+
+\func{wxString}{SavePerspective}{\void}
+
+Saves the entire user interface layout into an encoded wxString, which
+can then be stored by the application (probably using wxConfig). When
+a perspective is restored using LoadPerspective(), the entire user
+interface will return to the state it was when the perspective was saved.
+
+\membersection{wxAuiManager::SetArtProvider}\label{wxauimanagersetartprovider}
+
+\func{void}{SetArtProvider}{\param{wxAuiDockArt* }{art\_provider}}
+
+Instructs wxAuiManager to use art provider specified by parameter
+\arg{art\_provider} for all drawing calls. This allows plugable
+look-and-feel features. The previous art provider object, if any,
+will be deleted by wxAuiManager.
+
+See also: \helpref{wxAuiDockArt}{wxauidockart}.
+
+\membersection{wxAuiManager::SetFlags}\label{wxauimanagersetflags}
+
+\func{void}{SetFlags}{\param{unsigned int }{flags}}
+
+This method is used to specify wxAuiManager's settings flags. \arg{flags}
+specifies options which allow the frame management behavior to be modified.
+
+\membersection{wxAuiManager::SetManagedWindow}\label{wxauimanagersetmanagedwindow}
+
+\func{void}{SetManagedWindow}{\param{wxWindow* }{managed\_wnd}}
+
+Called to specify the frame or window which is to be managed by wxAuiManager.  Frame management is not restricted to just frames.  Child windows or custom controls are also allowed.
+
+\membersection{wxAuiManager::ShowHint}\label{wxauimanagershowhint}
+
+\func{void}{ShowHint}{\param{const wxRect\& }{rect}}
+
+This function is used by controls to explicitly show a hint window at the specified rectangle.  It is rarely called, and is mostly used by controls implementing custom pane drag/drop behaviour.  The specified rectangle should be in screen coordinates.
+
+\membersection{wxAuiManager::UnInit}\label{wxauimanageruninit}
+
+\func{void}{UnInit}{\void}
+
+Uninitializes the framework and should be called before a managed frame or window is destroyed. UnInit() is usually called in the managed wxFrame's destructor.  It is necessary to call this function before the managed frame or window is destroyed, otherwise the manager cannot remove its custom event handlers from a window.
+
+\membersection{wxAuiManager::Update}\label{wxauimanagerupdate}
+
+\func{void}{Update}{\void}
+
+This method is called after any number of changes are
+made to any of the managed panes. Update() must be invoked after
+AddPane() or InsertPane() are called in order to "realize" or "commit"
+the changes. In addition, any number of changes may be made to
+wxAuiPaneInfo structures (retrieved with wxAuiManager::GetPane), but to
+realize the changes, Update() must be called. This construction allows
+pane flicker to be avoided by updating the whole layout at one time.
+
diff --git a/docs/latex/wx/auipaneinfo.tex b/docs/latex/wx/auipaneinfo.tex
new file mode 100644
index 0000000000..9a6235ce4d
--- /dev/null
+++ b/docs/latex/wx/auipaneinfo.tex
@@ -0,0 +1,477 @@
+\section{\class{wxAuiPaneInfo}}\label{wxauipaneinfo}
+
+wxAuiPaneInfo is part of the wxAUI class framework.
+See also \helpref{wxAUI overview}{wxauioverview}.
+
+wxAuiPaneInfo specifies all the parameters for a pane.
+These parameters specify where the pane is on the
+screen, whether it is docked or floating, or hidden.
+In addition, these parameters specify the pane's
+docked position, floating position, preferred size,
+minimum size, caption text among many other parameters.
+
+\wxheading{Derived from}
+
+No base class
+
+\wxheading{Include files}
+
+<wx/aui/aui.h>
+
+\wxheading{See also}
+
+\helpref{wxAuiManager}{wxauimanager},
+\helpref{wxAuiDockArt}{wxauidockart}
+
+\wxheading{Data structures}
+
+\begin{verbatim}
+enum wxAuiPaneInsertLevel
+{
+    wxAUI_INSERT_PANE = 0,
+    wxAUI_INSERT_ROW = 1,
+    wxAUI_INSERT_DOCK = 2
+}
+\end{verbatim}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxAuiPaneInfo::wxAuiPaneInfo}\label{wxauipaneinfowxauipaneinfo}
+
+\func{}{wxAuiPaneInfo}{\void}
+
+Default constructor.
+
+\func{}{wxAuiPaneInfo}{\param{const wxAuiPaneInfo\& }{c}}
+
+Copy constructor.
+
+\membersection{wxAuiPaneInfo::\destruct{wxAuiPaneInfo}}\label{wxauipaneinfodtor}
+
+\func{}{\destruct{wxAuiPaneInfo}}{\void}
+
+
+\membersection{wxAuiPaneInfo::BestSize}\label{wxauipaneinfobestsize}
+
+\func{wxAuiPaneInfo\&}{BestSize}{\param{const wxSize\& }{size}}
+\func{wxAuiPaneInfo\&}{BestSize}{\param{int }{x}, \param{int }{y}}
+
+BestSize() sets the ideal size for the pane.  The docking manager will attempt to use this size as much as possible when docking or floating the pane.
+
+\membersection{wxAuiPaneInfo::Bottom}\label{wxauipaneinfobottom}
+
+\func{wxAuiPaneInfo\&}{Bottom}{\void}
+
+Bottom() sets the pane dock position to the bottom side of the frame.  This is the same thing as calling Direction(wxAUI_DOCK_BOTTOM).
+
+\membersection{wxAuiPaneInfo::BottomDockable}\label{wxauipaneinfobottomdockable}
+
+\func{wxAuiPaneInfo\&}{BottomDockable}{\param{bool }{b = true}}
+
+BottomDockable() indicates whether a pane can be docked at the bottom of the frame.
+
+\membersection{wxAuiPaneInfo::Caption}\label{wxauipaneinfocaption}
+
+\func{wxAuiPaneInfo\&}{Caption}{\param{const wxString\& }{c}}
+
+Caption() sets the caption of the pane.
+
+\membersection{wxAuiPaneInfo::CaptionVisible}\label{wxauipaneinfocaptionvisible}
+
+\func{wxAuiPaneInfo\&}{CaptionVisible}{\param{bool }{visible = true}}
+
+CaptionVisible indicates that a pane caption should be visible.  If false, no pane caption is drawn.
+
+\membersection{wxAuiPaneInfo::Centre}\label{wxauipaneinfocentre}
+
+\func{wxAuiPaneInfo\&}{Centre}{\void}
+\func{wxAuiPaneInfo\&}{Center}{\void}
+
+Center() sets the pane dock position to the left side of the frame.  This is the same thing as calling Direction(wxAUI_DOCK_CENTRE).
+
+\membersection{wxAuiPaneInfo::CentrePane}\label{wxauipaneinfocentrepane}
+
+\func{wxAuiPaneInfo\&}{CentrePane}{\void}
+\func{wxAuiPaneInfo\&}{CenterPane}{\void}
+
+CentrePane() specifies that the pane should adopt the default centre pane settings.
+
+\membersection{wxAuiPaneInfo::Centre}\label{wxauipaneinfocentre}
+
+\func{wxAuiPaneInfo\&}{Centre}{\void}
+\func{wxAuiPaneInfo\&}{Center}{\void}
+
+Centre() sets the pane to the center position of the frame.  The centre pane is the space in the middle after all border panes (left, top, right, bottom) are subtracted from the layout.
+
+\membersection{wxAuiPaneInfo::CentrePane}\label{wxauipaneinfocentrepane}
+
+\func{wxAuiPaneInfo\&}{CentrePane}{\void}
+\func{wxAuiPaneInfo\&}{CenterPane}{\void}
+
+CentrePane() specifies that the pane should adopt the default center pane settings.  Centre panes usually do not have caption bars.  This function provides an easy way of preparing a pane to be displayed in the center dock position.
+
+\membersection{wxAuiPaneInfo::CloseButton}\label{wxauipaneinfoclosebutton}
+
+\func{wxAuiPaneInfo\&}{CloseButton}{\param{bool }{visible = true}}
+
+CloseButton() indicates that a close button should be drawn for the pane.
+
+\membersection{wxAuiPaneInfo::DefaultPane}\label{wxauipaneinfodefaultpane}
+
+\func{wxAuiPaneInfo\&}{DefaultPane}{\void}
+
+DefaultPane() specifies that the pane should adopt the default pane settings.
+
+\membersection{wxAuiPaneInfo::DestroyOnClose}\label{wxauipaneinfodestroyonclose}
+
+\func{wxAuiPaneInfo\&}{DestroyOnClose}{\param{bool }{b = true}}
+
+DestroyOnClose() indicates whether a pane should be detroyed when it is closed.  Normally a pane is simply hidden when the close button is clicked.  Setting DestroyOnClose to true will cause the window to be destroyed when the user clicks the pane's close button.
+
+\membersection{wxAuiPaneInfo::Direction}\label{wxauipaneinfodirection}
+
+\func{wxAuiPaneInfo\&}{Direction}{\param{int }{direction}}
+
+Direction() determines the direction of the docked pane.  It is functionally the same as calling Left(), Right(), Top() or Bottom(), except that docking direction may be specified programmatically via the parameter.
+
+\membersection{wxAuiPaneInfo::Dock}\label{wxauipaneinfodock}
+
+\func{wxAuiPaneInfo\&}{Dock}{\void}
+
+
+\membersection{wxAuiPaneInfo::Dockable}\label{wxauipaneinfodockable}
+
+\func{wxAuiPaneInfo\&}{Dockable}{\param{bool }{b = true}}
+
+Dockable() specifies whether a frame can be docked or not.  It is the same as specifying TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b).
+
+\membersection{wxAuiPaneInfo::Fixed}\label{wxauipaneinfofixed}
+
+\func{wxAuiPaneInfo\&}{Fixed}{\void}
+
+Fixed() forces a pane to be fixed size so that it cannot be resized.  After calling Fixed(), IsFixed() will return true.
+
+\membersection{wxAuiPaneInfo::Float}\label{wxauipaneinfofloat}
+
+\func{wxAuiPaneInfo\&}{Float}{\void}
+
+Float() indicates that a pane should be floated.
+
+\membersection{wxAuiPaneInfo::Floatable}\label{wxauipaneinfofloatable}
+
+\func{wxAuiPaneInfo\&}{Floatable}{\param{bool }{b = true}}
+
+Floatable() sets whether the user will be able to undock a pane and turn it into a floating window.
+
+\membersection{wxAuiPaneInfo::FloatingPosition}\label{wxauipaneinfofloatingposition}
+
+\func{wxAuiPaneInfo\&}{FloatingPosition}{\param{const wxPoint\& }{pos}}
+\func{wxAuiPaneInfo\&}{FloatingPosition}{\param{int }{x}, \param{int }{y}}
+
+FloatingPosition() sets the position of the floating pane.
+
+\membersection{wxAuiPaneInfo::FloatingSize}\label{wxauipaneinfofloatingsize}
+
+\func{wxAuiPaneInfo\&}{FloatingSize}{\param{const wxSize\& }{size}}
+\func{wxAuiPaneInfo\&}{FloatingSize}{\param{int }{x}, \param{int }{y}}
+
+FloatingSize() sets the size of the floating pane.
+
+\membersection{wxAuiPaneInfo::Gripper}\label{wxauipaneinfogripper}
+
+\func{wxAuiPaneInfo\&}{Gripper}{\param{bool }{visible = true}}
+
+Gripper() indicates that a gripper should be drawn for the pane.
+
+\membersection{wxAuiPaneInfo::GripperTop}\label{wxauipaneinfogrippertop}
+
+\func{wxAuiPaneInfo\&}{GripperTop}{\param{bool }{attop = true}}
+
+GripperTop() indicates that a gripper should be drawn at the top of the pane.
+
+\membersection{wxAuiPaneInfo::HasBorder}\label{wxauipaneinfohasborder}
+
+\constfunc{bool}{HasBorder}{\void}
+
+HasBorder() returns true if the pane displays a border.
+
+\membersection{wxAuiPaneInfo::HasCaption}\label{wxauipaneinfohascaption}
+
+\constfunc{bool}{HasCaption}{\void}
+
+HasCaption() returns true if the pane displays a caption.
+
+\membersection{wxAuiPaneInfo::HasCloseButton}\label{wxauipaneinfohasclosebutton}
+
+\constfunc{bool}{HasCloseButton}{\void}
+
+HasCloseButton() returns true if the pane displays a button to close the pane.
+
+\membersection{wxAuiPaneInfo::HasFlag}\label{wxauipaneinfohasflag}
+
+\constfunc{bool}{HasFlag}{\param{unsigned int }{flag}}
+
+HasFlag() returns true if the the property specified by flag is active for the pane.
+
+\membersection{wxAuiPaneInfo::HasGripper}\label{wxauipaneinfohasgripper}
+
+\constfunc{bool}{HasGripper}{\void}
+
+HasGripper() returns true if the pane displays a gripper.
+
+\membersection{wxAuiPaneInfo::HasGripperTop}\label{wxauipaneinfohasgrippertop}
+
+\constfunc{bool}{HasGripperTop}{\void}
+
+HasGripper() returns true if the pane displays a gripper at the top.
+
+\membersection{wxAuiPaneInfo::HasMaximizeButton}\label{wxauipaneinfohasmaximizebutton}
+
+\constfunc{bool}{HasMaximizeButton}{\void}
+
+HasMaximizeButton() returns true if the pane displays a button to maximize the pane.
+
+\membersection{wxAuiPaneInfo::HasMinimizeButton}\label{wxauipaneinfohasminimizebutton}
+
+\constfunc{bool}{HasMinimizeButton}{\void}
+
+HasMinimizeButton() returns true if the pane displays a button to minimize the pane.
+
+\membersection{wxAuiPaneInfo::HasPinButton}\label{wxauipaneinfohaspinbutton}
+
+\constfunc{bool}{HasPinButton}{\void}
+
+HasPinButton() returns true if the pane displays a button to float the pane.
+
+\membersection{wxAuiPaneInfo::Hide}\label{wxauipaneinfohide}
+
+\func{wxAuiPaneInfo\&}{Hide}{\void}
+
+Hide() indicates that a pane should be hidden.
+
+\membersection{wxAuiPaneInfo::IsBottomDockable}\label{wxauipaneinfoisbottomdockable}
+
+\constfunc{bool}{IsBottomDockable}{\void}
+
+IsBottomDockable() returns true if the pane can be docked at the bottom of the managed frame.
+
+\membersection{wxAuiPaneInfo::IsDocked}\label{wxauipaneinfoisdocked}
+
+\constfunc{bool}{IsDocked}{\void}
+
+IsDocked() returns true if the pane is docked.
+
+\membersection{wxAuiPaneInfo::IsFixed}\label{wxauipaneinfoisfixed}
+
+\constfunc{bool}{IsFixed}{\void}
+
+IsFixed() returns true if the pane cannot be resized.
+
+\membersection{wxAuiPaneInfo::IsFloatable}\label{wxauipaneinfoisfloatable}
+
+\constfunc{bool}{IsFloatable}{\void}
+
+IsFloatable() returns true if the pane can be undocked and displayed as a floating window.
+
+\membersection{wxAuiPaneInfo::IsFloating}\label{wxauipaneinfoisfloating}
+
+\constfunc{bool}{IsFloating}{\void}
+
+IsFloating() returns true if the pane is floating.
+
+\membersection{wxAuiPaneInfo::IsLeftDockable}\label{wxauipaneinfoisleftdockable}
+
+\constfunc{bool}{IsLeftDockable}{\void}
+
+IsLeftDockable() returns true if the pane can be docked on the left of the managed frame.
+
+\membersection{wxAuiPaneInfo::IsMovable}\label{wxauipaneinfoismovable}
+
+\constfunc{bool}{IsMovable}{\void}
+
+IsMoveable() returns true if the docked frame can be undocked or moved to another dock position.
+
+\membersection{wxAuiPaneInfo::IsOk}\label{wxauipaneinfoisok}
+
+\constfunc{bool}{IsOk}{\void}
+
+IsOk() returns true if the wxAuiPaneInfo structure is valid.  A pane structure is valid if it has an associated window.
+
+\membersection{wxAuiPaneInfo::IsResizable}\label{wxauipaneinfoisresizable}
+
+\constfunc{bool}{IsResizable}{\void}
+
+IsResizable() returns true if the pane can be resized.
+
+\membersection{wxAuiPaneInfo::IsRightDockable}\label{wxauipaneinfoisrightdockable}
+
+\constfunc{bool}{IsRightDockable}{\void}
+
+IsRightDockable() returns true if the pane can be docked on the right of the managed frame.
+
+\membersection{wxAuiPaneInfo::IsShown}\label{wxauipaneinfoisshown}
+
+\constfunc{bool}{IsShown}{\void}
+
+IsShown() returns true if the pane is currently shown.
+
+\membersection{wxAuiPaneInfo::IsToolbar}\label{wxauipaneinfoistoolbar}
+
+\constfunc{bool}{IsToolbar}{\void}
+
+IsToolbar() returns true if the pane contains a toolbar.
+
+\membersection{wxAuiPaneInfo::IsTopDockable}\label{wxauipaneinfoistopdockable}
+
+\constfunc{bool}{IsTopDockable}{\void}
+
+IsTopDockable() returns true if the pane can be docked at the top of the managed frame.
+
+\membersection{wxAuiPaneInfo::Layer}\label{wxauipaneinfolayer}
+
+\func{wxAuiPaneInfo\&}{Layer}{\param{int }{layer}}
+
+Layer() determines the layer of the docked pane.  The dock layer is similar to an onion, the inner-most layer being layer 0.  Each shell moving in the outward direction has a higher layer number.  This allows for more complex docking layout formation.
+
+\membersection{wxAuiPaneInfo::Left}\label{wxauipaneinfoleft}
+
+\func{wxAuiPaneInfo\&}{Left}{\void}
+
+Left() sets the pane dock position to the left side of the frame.  This is the same thing as calling Direction(wxAUI_DOCK_LEFT).
+
+\membersection{wxAuiPaneInfo::LeftDockable}\label{wxauipaneinfoleftdockable}
+
+\func{wxAuiPaneInfo\&}{LeftDockable}{\param{bool }{b = true}}
+
+LeftDockable() indicates whether a pane can be docked on the left of the frame.
+
+\membersection{wxAuiPaneInfo::MaxSize}\label{wxauipaneinfomaxsize}
+
+\func{wxAuiPaneInfo\&}{MaxSize}{\param{const wxSize\& }{size}}
+\func{wxAuiPaneInfo\&}{MaxSize}{\param{int }{x}, \param{int }{y}}
+
+MaxSize() sets the maximum size of the pane.
+
+\membersection{wxAuiPaneInfo::MaximizeButton}\label{wxauipaneinfomaximizebutton}
+
+\func{wxAuiPaneInfo\&}{MaximizeButton}{\param{bool }{visible = true}}
+
+MaximizeButton() indicates that a maximize button should be drawn for the pane.
+
+\membersection{wxAuiPaneInfo::MinSize}\label{wxauipaneinfominsize}
+
+\func{wxAuiPaneInfo\&}{MinSize}{\param{const wxSize\& }{size}}
+\func{wxAuiPaneInfo\&}{MinSize}{\param{int }{x}, \param{int }{y}}
+
+MinSize() sets the minimum size of the pane.  Please note that this is only partially supported as of this writing.
+
+\membersection{wxAuiPaneInfo::MinimizeButton}\label{wxauipaneinfominimizebutton}
+
+\func{wxAuiPaneInfo\&}{MinimizeButton}{\param{bool }{visible = true}}
+
+MinimizeButton() indicates that a minimize button should be drawn for the pane.
+
+\membersection{wxAuiPaneInfo::Movable}\label{wxauipaneinfomovable}
+
+\func{wxAuiPaneInfo\&}{Movable}{\param{bool }{b = true}}
+
+Movable indicates whether a frame can be moved.
+
+\membersection{wxAuiPaneInfo::Name}\label{wxauipaneinfoname}
+
+\func{wxAuiPaneInfo\&}{Name}{\param{const wxString\& }{n}}
+
+Name() sets the name of the pane so it can be referenced in lookup functions.  If a name is not specified by the user, a random name is assigned to the pane when it is added to the manager.
+
+\membersection{wxAuiPaneInfo::PaneBorder}\label{wxauipaneinfopaneborder}
+
+\func{wxAuiPaneInfo\&}{PaneBorder}{\param{bool }{visible = true}}
+
+PaneBorder indicates that a border should be drawn for the pane.
+
+\membersection{wxAuiPaneInfo::PinButton}\label{wxauipaneinfopinbutton}
+
+\func{wxAuiPaneInfo\&}{PinButton}{\param{bool }{visible = true}}
+
+PinButton() indicates that a pin button should be drawn for the pane.
+
+\membersection{wxAuiPaneInfo::Position}\label{wxauipaneinfoposition}
+
+\func{wxAuiPaneInfo\&}{Position}{\param{int }{pos}}
+
+Position() determines the position of the docked pane.
+
+\membersection{wxAuiPaneInfo::Resizable}\label{wxauipaneinforesizable}
+
+\func{wxAuiPaneInfo\&}{Resizable}{\param{bool }{resizable = true}}
+
+Resizable() allows a pane to be resized if the parameter is true, and forces it to be a fixed size if the parameter is false.  This is simply an antonym for Fixed().
+
+\membersection{wxAuiPaneInfo::Right}\label{wxauipaneinforight}
+
+\func{wxAuiPaneInfo\&}{Right}{\void}
+
+Right() sets the pane dock position to the right side of the frame.
+
+\membersection{wxAuiPaneInfo::RightDockable}\label{wxauipaneinforightdockable}
+
+\func{wxAuiPaneInfo\&}{RightDockable}{\param{bool }{b = true}}
+
+RightDockable() indicates whether a pane can be docked on the right of the frame.
+
+\membersection{wxAuiPaneInfo::Row}\label{wxauipaneinforow}
+
+\func{wxAuiPaneInfo\&}{Row}{\param{int }{row}}
+
+Row() determines the row of the docked pane.
+
+\membersection{wxAuiPaneInfo::SafeSet}\label{wxauipaneinfosafeset}
+
+\func{void}{SafeSet}{\param{wxAuiPaneInfo }{source}}
+
+Write the safe parts of a newly loaded PaneInfo structure "source" into "this"
+used on loading perspectives etc.
+
+\membersection{wxAuiPaneInfo::SetFlag}\label{wxauipaneinfosetflag}
+
+\func{wxAuiPaneInfo\&}{SetFlag}{\param{unsigned int }{flag}, \param{bool }{option\_state}}
+
+SetFlag() turns the property given by flag on or off with the option_state parameter.
+
+\membersection{wxAuiPaneInfo::Show}\label{wxauipaneinfoshow}
+
+\func{wxAuiPaneInfo\&}{Show}{\param{bool }{show = true}}
+
+Show() indicates that a pane should be shown.
+
+\membersection{wxAuiPaneInfo::ToolbarPane}\label{wxauipaneinfotoolbarpane}
+
+\func{wxAuiPaneInfo\&}{ToolbarPane}{\void}
+
+ToolbarPane() specifies that the pane should adopt the default toolbar pane settings.
+
+\membersection{wxAuiPaneInfo::Top}\label{wxauipaneinfotop}
+
+\func{wxAuiPaneInfo\&}{Top}{\void}
+
+Top() sets the pane dock position to the top of the frame.
+
+\membersection{wxAuiPaneInfo::TopDockable}\label{wxauipaneinfotopdockable}
+
+\func{wxAuiPaneInfo\&}{TopDockable}{\param{bool }{b = true}}
+
+TopDockable() indicates whether a pane can be docked at the top of the frame.
+
+\membersection{wxAuiPaneInfo::Window}\label{wxauipaneinfowindow}
+
+\func{wxAuiPaneInfo\&}{Window}{\param{wxWindow* }{w}}
+
+Window() assigns the window pointer that the wxAuiPaneInfo should use.  This normally does not need to be specified, as the window pointer is automatically assigned to the wxAuiPaneInfo structure as soon as it is added to the manager.
+
+\membersection{wxAuiPaneInfo::operator=}\label{wxauipaneinfooperatorassign}
+
+\func{wxAuiPaneInfo\& operator}{operator=}{\param{const wxAuiPaneInfo\& }{c}}
+
+Makes a copy of the wxAuiPaneInfo object.
+
-- 
2.50.0

