Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

wxaui docs after big rename

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@42917 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Benjamin Williams
2006-11-01 19:03:05 +00:00
parent a3a5df9d92
commit fbf40a19f5
3 changed files with 189 additions and 189 deletions
Download Patch File Download Diff File Expand all files Collapse all files

116
docs/latex/wx/framemanager.tex
View File

@@ -1,20 +1,20 @@
\section{\class{wxFrameManager}}\label{wxframemanager} \section{\class{wxAuiManager}}\label{wxauimanager}
wxFrameManager is the central class of the wxAUI class framework. wxAuiManager is the central class of the wxAUI class framework.
See also \helpref{wxAUI overview}{wxauioverview}. See also \helpref{wxAUI overview}{wxauioverview}.
wxFrameManager manages the panes associated with it wxAuiManager manages the panes associated with it
for a particular wxFrame, using a pane's wxPaneInfo information to for a particular wxFrame, using a pane's wxAuiPaneInfo information to
determine each pane's docking and floating behavior. wxFrameManager determine each pane's docking and floating behavior. wxAuiManager
uses wxWidgets' sizer mechanism to plan the layout of each frame. It 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 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 localized in one area, and may be customized depending on an
applications' specific needs. applications' specific needs.
wxFrameManager 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 or makes changes to existing pane properties (dock position, floating
state, show state, etc.). To apply these changes, wxFrameManager's state, show state, etc.). To apply these changes, wxAuiManager's
Update() function is called. This batch processing can be used to avoid 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" flicker, by modifying more than one pane at a time, and then "committing"
all of the changes at once by calling Update(). all of the changes at once by calling Update().
@@ -81,12 +81,12 @@ understand layers is by running the wxAUI sample.
\wxheading{See also} \wxheading{See also}
\helpref{wxPaneInfo}{wxpaneinfo} \helpref{wxAuiPaneInfo}{wxauipaneinfo}
\wxheading{Data structures} \wxheading{Data structures}
\begin{verbatim} \begin{verbatim}
enum wxFrameManagerDock enum wxAuiManagerDock
{ {
wxAUI_DOCK_NONE = 0, wxAUI_DOCK_NONE = 0,
wxAUI_DOCK_TOP = 1, wxAUI_DOCK_TOP = 1,
@@ -99,7 +99,7 @@ enum wxFrameManagerDock
\end{verbatim} \end{verbatim}
\begin{verbatim} \begin{verbatim}
enum wxFrameManagerOption enum wxAuiManagerOption
{ {
wxAUI_MGR_ALLOW_FLOATING = 1 << 0, wxAUI_MGR_ALLOW_FLOATING = 1 << 0,
wxAUI_MGR_ALLOW_ACTIVE_PANE = 1 << 1, wxAUI_MGR_ALLOW_ACTIVE_PANE = 1 << 1,
@@ -121,85 +121,85 @@ enum wxFrameManagerOption
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxFrameManager::wxFrameManager}\label{wxframemanagerwxframemanager} \membersection{wxAuiManager::wxAuiManager}\label{wxauimanagerwxauimanager}
\func{}{wxFrameManager}{\param{wxWindow* }{managed\_wnd = NULL}, \param{unsigned int }{flags = wxAUI\_MGR\_DEFAULT}} \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{frame} specifies the wxFrame which should be managed.
\arg{flags} specifies options which allow the frame management behavior \arg{flags} specifies options which allow the frame management behavior
to be modified. to be modified.
\membersection{wxFrameManager::\destruct{wxFrameManager}}\label{wxframemanagerdtor} \membersection{wxAuiManager::\destruct{wxAuiManager}}\label{wxauimanagerdtor}
\func{}{\destruct{wxFrameManager}}{\void} \func{}{\destruct{wxAuiManager}}{\void}
\membersection{wxFrameManager::AddPane}\label{wxframemanageraddpane} \membersection{wxAuiManager::AddPane}\label{wxauimanageraddpane}
\func{bool}{AddPane}{\param{wxWindow* }{window}, \param{const wxPaneInfo\& }{pane\_info}} \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{int }{direction = wxLEFT}, \param{const wxString\& }{caption = wxEmptyString}}
\func{bool}{AddPane}{\param{wxWindow* }{window}, \param{const wxPaneInfo\& }{pane\_info}, \param{const wxPoint\& }{drop\_pos}} \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. 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{wxFrameManager::DetachPane}\label{wxframemanagerdetachpane} \membersection{wxAuiManager::DetachPane}\label{wxauimanagerdetachpane}
\func{bool}{DetachPane}{\param{wxWindow* }{window}} \func{bool}{DetachPane}{\param{wxWindow* }{window}}
Tells the wxFrameManager to stop managing the pane specified by 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 The window, if in a floated frame, is reparented to the frame managed
by wxFrameManager. by wxAuiManager.
\membersection{wxFrameManager::GetAllPanes}\label{wxframemanagergetallpanes} \membersection{wxAuiManager::GetAllPanes}\label{wxauimanagergetallpanes}
\func{wxPaneInfoArray\&}{GetAllPanes}{\void} \func{wxAuiPaneInfoArray\&}{GetAllPanes}{\void}
Returns an array of all panes managed by the frame manager. Returns an array of all panes managed by the frame manager.
\membersection{wxFrameManager::GetArtProvider}\label{wxframemanagergetartprovider} \membersection{wxAuiManager::GetArtProvider}\label{wxauimanagergetartprovider}
\constfunc{wxDockArt*}{GetArtProvider}{\void} \constfunc{wxAuiDockArt*}{GetArtProvider}{\void}
Returns the current art provider being used. Returns the current art provider being used.
\membersection{wxFrameManager::GetFlags}\label{wxframemanagergetflags} \membersection{wxAuiManager::GetFlags}\label{wxauimanagergetflags}
\constfunc{unsigned int}{GetFlags}{\void} \constfunc{unsigned int}{GetFlags}{\void}
Returns the current manager's flags. Returns the current manager's flags.
\membersection{wxFrameManager::GetManagedWindow}\label{wxframemanagergetmanagedwindow} \membersection{wxAuiManager::GetManagedWindow}\label{wxauimanagergetmanagedwindow}
\constfunc{wxWindow*}{GetManagedWindow}{\void} \constfunc{wxWindow*}{GetManagedWindow}{\void}
Returns the frame currently being managed by wxFrameManager. Returns the frame currently being managed by wxAuiManager.
\membersection{wxFrameManager::GetPane}\label{wxframemanagergetpane} \membersection{wxAuiManager::GetPane}\label{wxauimanagergetpane}
\func{wxPaneInfo\&}{GetPane}{\param{wxWindow* }{window}} \func{wxAuiPaneInfo\&}{GetPane}{\param{wxWindow* }{window}}
\func{wxPaneInfo\&}{GetPane}{\param{const wxString\& }{name}} \func{wxAuiPaneInfo\&}{GetPane}{\param{const wxString\& }{name}}
{\it GetPane} is used to lookup a wxPaneInfo object {\it GetPane} is used to lookup a wxAuiPaneInfo object
either by window pointer or by pane name, which acts as a unique id for either by window pointer or by pane name, which acts as a unique id for
a window pane. The returned wxPaneInfo object may then be modified to a window pane. The returned wxAuiPaneInfo object may then be modified to
change a pane's look, state or position. After one or more change a pane's look, state or position. After one or more
modifications to wxPaneInfo, wxFrameManager::Update() should be called modifications to wxAuiPaneInfo, wxAuiManager::Update() should be called
to commit the changes to the user interface. If the lookup failed 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 (meaning the pane could not be found in the manager), a call to the
returned wxPaneInfo's IsOk() method will return false. returned wxAuiPaneInfo's IsOk() method will return false.
\membersection{wxFrameManager::HideHint}\label{wxframemanagerhidehint} \membersection{wxAuiManager::HideHint}\label{wxauimanagerhidehint}
\func{void}{HideHint}{\void} \func{void}{HideHint}{\void}
HideHint() hides any docking hint that may be visible. HideHint() hides any docking hint that may be visible.
\membersection{wxFrameManager::InsertPane}\label{wxframemanagerinsertpane} \membersection{wxAuiManager::InsertPane}\label{wxauimanagerinsertpane}
\func{bool}{InsertPane}{\param{wxWindow* }{window}, \param{const wxPaneInfo\& }{insert\_location}, \param{int }{insert\_level = wxAUI\_INSERT\_PANE}} \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 This method is used to insert either a previously unmanaged pane window
into the frame manager, or to insert a currently managed pane somewhere into the frame manager, or to insert a currently managed pane somewhere
@@ -210,32 +210,32 @@ 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 parameter \arg{insert\_level} can take a value of wxAUI\_INSERT\_PANE, wxAUI\_INSERT\_ROW
or wxAUI\_INSERT\_DOCK. or wxAUI\_INSERT\_DOCK.
\membersection{wxFrameManager::LoadPaneInfo}\label{wxframemanagerloadpaneinfo} \membersection{wxAuiManager::LoadPaneInfo}\label{wxauimanagerloadpaneinfo}
\func{void}{LoadPaneInfo}{\param{wxString }{pane\_part}, \param{wxPaneInfo\& }{pane}} \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(). 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{wxFrameManager::LoadPerspective}\label{wxframemanagerloadperspective} \membersection{wxAuiManager::LoadPerspective}\label{wxauimanagerloadperspective}
\func{bool}{LoadPerspective}{\param{const wxString\& }{perspective}, \param{bool }{update = true}} \func{bool}{LoadPerspective}{\param{const wxString\& }{perspective}, \param{bool }{update = true}}
Loads a saved perspective. If update is true, wxFrameManager::Update() Loads a saved perspective. If update is true, wxAuiManager::Update()
is automatically invoked, thus realizing the saved perspective on screen. is automatically invoked, thus realizing the saved perspective on screen.
\membersection{wxFrameManager::ProcessDockResult}\label{wxframemanagerprocessdockresult} \membersection{wxAuiManager::ProcessDockResult}\label{wxauimanagerprocessdockresult}
\func{bool}{ProcessDockResult}{\param{wxPaneInfo\& }{target}, \param{const wxPaneInfo\& }{new\_pos}} \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. ProcessDockResult() is a protected member of the wxAUI layout manager. It can be overridden by derived classes to provide custom docking calculations.
\membersection{wxFrameManager::SavePaneInfo}\label{wxframemanagersavepaneinfo} \membersection{wxAuiManager::SavePaneInfo}\label{wxauimanagersavepaneinfo}
\func{wxString}{SavePaneInfo}{\param{wxPaneInfo\& }{pane}} \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(). 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{wxFrameManager::SavePerspective}\label{wxframemanagersaveperspective} \membersection{wxAuiManager::SavePerspective}\label{wxauimanagersaveperspective}
\func{wxString}{SavePerspective}{\void} \func{wxString}{SavePerspective}{\void}
@@ -244,41 +244,41 @@ can then be stored by the application (probably using wxConfig). When
a perspective is restored using LoadPerspective(), the entire user a perspective is restored using LoadPerspective(), the entire user
interface will return to the state it was when the perspective was saved. interface will return to the state it was when the perspective was saved.
\membersection{wxFrameManager::SetArtProvider}\label{wxframemanagersetartprovider} \membersection{wxAuiManager::SetArtProvider}\label{wxauimanagersetartprovider}
\func{void}{SetArtProvider}{\param{wxDockArt* }{art\_provider}} \func{void}{SetArtProvider}{\param{wxAuiDockArt* }{art\_provider}}
Instructs wxFrameManager to use art provider specified by parameter Instructs wxAuiManager to use art provider specified by parameter
\arg{art\_provider} for all drawing calls. This allows plugable \arg{art\_provider} for all drawing calls. This allows plugable
look-and-feel features. The previous art provider object, if any, look-and-feel features. The previous art provider object, if any,
will be deleted by wxFrameManager. will be deleted by wxAuiManager.
\membersection{wxFrameManager::SetFlags}\label{wxframemanagersetflags} \membersection{wxAuiManager::SetFlags}\label{wxauimanagersetflags}
\func{void}{SetFlags}{\param{unsigned int }{flags}} \func{void}{SetFlags}{\param{unsigned int }{flags}}
This method is used to specify wxFrameManager's settings flags. \arg{flags} This method is used to specify wxAuiManager's settings flags. \arg{flags}
specifies options which allow the frame management behavior to be modified. specifies options which allow the frame management behavior to be modified.
\membersection{wxFrameManager::SetManagedWindow}\label{wxframemanagersetmanagedwindow} \membersection{wxAuiManager::SetManagedWindow}\label{wxauimanagersetmanagedwindow}
\func{void}{SetManagedWindow}{\param{wxWindow* }{managed\_wnd}} \func{void}{SetManagedWindow}{\param{wxWindow* }{managed\_wnd}}
Called to specify the frame or window which is to be managed by wxFrameManager. Frame management is not restricted to just frames. Child windows or custom controls are also allowed. 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{wxFrameManager::ShowHint}\label{wxframemanagershowhint} \membersection{wxAuiManager::ShowHint}\label{wxauimanagershowhint}
\func{void}{ShowHint}{\param{const wxRect\& }{rect}} \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. 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{wxFrameManager::UnInit}\label{wxframemanageruninit} \membersection{wxAuiManager::UnInit}\label{wxauimanageruninit}
\func{void}{UnInit}{\void} \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. 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{wxFrameManager::Update}\label{wxframemanagerupdate} \membersection{wxAuiManager::Update}\label{wxauimanagerupdate}
\func{void}{Update}{\void} \func{void}{Update}{\void}
@@ -286,7 +286,7 @@ This method is called after any number of changes are
made to any of the managed panes. Update() must be invoked after made to any of the managed panes. Update() must be invoked after
AddPane() or InsertPane() are called in order to "realize" or "commit" AddPane() or InsertPane() are called in order to "realize" or "commit"
the changes. In addition, any number of changes may be made to the changes. In addition, any number of changes may be made to
wxPaneInfo structures (retrieved with wxFrameManager::GetPane), but to wxAuiPaneInfo structures (retrieved with wxAuiManager::GetPane), but to
realize the changes, Update() must be called. This construction allows realize the changes, Update() must be called. This construction allows
pane flicker to be avoided by updating the whole layout at one time. pane flicker to be avoided by updating the whole layout at one time.

260
docs/latex/wx/paneinfo.tex
View File

@@ -1,9 +1,9 @@
\section{\class{wxPaneInfo}}\label{wxpaneinfo} \section{\class{wxAuiPaneInfo}}\label{wxauipaneinfo}
wxPaneInfo is part of the wxAUI class framework. wxAuiPaneInfo is part of the wxAUI class framework.
See also \helpref{wxAUI overview}{wxauioverview}. See also \helpref{wxAUI overview}{wxauioverview}.
wxPaneInfo specifies all the parameters for a pane. wxAuiPaneInfo specifies all the parameters for a pane.
These parameters specify where the pane is on the These parameters specify where the pane is on the
screen, whether it is docked or floating, or hidden. screen, whether it is docked or floating, or hidden.
In addition, these parameters specify the pane's In addition, these parameters specify the pane's
@@ -20,7 +20,7 @@ No base class
\wxheading{See also} \wxheading{See also}
\helpref{wxFrameManager}{wxframemanager} \helpref{wxAuiManager}{wxauimanager}
\wxheading{Data structures} \wxheading{Data structures}
@@ -77,378 +77,378 @@ enum wxPaneInsertLevel
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPaneInfo::wxPaneInfo}\label{wxpaneinfowxpaneinfo} \membersection{wxAuiPaneInfo::wxAuiPaneInfo}\label{wxauipaneinfowxauipaneinfo}
\func{}{wxPaneInfo}{\void} \func{}{wxAuiPaneInfo}{\void}
\func{}{wxPaneInfo}{\param{const wxPaneInfo\& }{c}} \func{}{wxAuiPaneInfo}{\param{const wxAuiPaneInfo\& }{c}}
\membersection{wxPaneInfo::\destruct{wxPaneInfo}}\label{wxpaneinfodtor} \membersection{wxAuiPaneInfo::\destruct{wxAuiPaneInfo}}\label{wxauipaneinfodtor}
\func{}{\destruct{wxPaneInfo}}{\void} \func{}{\destruct{wxAuiPaneInfo}}{\void}
\membersection{wxPaneInfo::BestSize}\label{wxpaneinfobestsize} \membersection{wxAuiPaneInfo::BestSize}\label{wxauipaneinfobestsize}
\func{wxPaneInfo\&}{BestSize}{\param{const wxSize\& }{size}} \func{wxAuiPaneInfo\&}{BestSize}{\param{const wxSize\& }{size}}
\func{wxPaneInfo\&}{BestSize}{\param{int }{x}, \param{int }{y}} \func{wxAuiPaneInfo\&}{BestSize}{\param{int }{x}, \param{int }{y}}
\membersection{wxPaneInfo::Bottom}\label{wxpaneinfobottom} \membersection{wxAuiPaneInfo::Bottom}\label{wxauipaneinfobottom}
\func{wxPaneInfo\&}{Bottom}{\void} \func{wxAuiPaneInfo\&}{Bottom}{\void}
\membersection{wxPaneInfo::BottomDockable}\label{wxpaneinfobottomdockable} \membersection{wxAuiPaneInfo::BottomDockable}\label{wxauipaneinfobottomdockable}
\func{wxPaneInfo\&}{BottomDockable}{\param{bool }{b = true}} \func{wxAuiPaneInfo\&}{BottomDockable}{\param{bool }{b = true}}
\membersection{wxPaneInfo::Caption}\label{wxpaneinfocaption} \membersection{wxAuiPaneInfo::Caption}\label{wxauipaneinfocaption}
\func{wxPaneInfo\&}{Caption}{\param{const wxString\& }{c}} \func{wxAuiPaneInfo\&}{Caption}{\param{const wxString\& }{c}}
\membersection{wxPaneInfo::CaptionVisible}\label{wxpaneinfocaptionvisible} \membersection{wxAuiPaneInfo::CaptionVisible}\label{wxauipaneinfocaptionvisible}
\func{wxPaneInfo\&}{CaptionVisible}{\param{bool }{visible = true}} \func{wxAuiPaneInfo\&}{CaptionVisible}{\param{bool }{visible = true}}
\membersection{wxPaneInfo::Center}\label{wxpaneinfocenter} \membersection{wxAuiPaneInfo::Center}\label{wxauipaneinfocenter}
\func{wxPaneInfo\&}{Center}{\void} \func{wxAuiPaneInfo\&}{Center}{\void}
\membersection{wxPaneInfo::CenterPane}\label{wxpaneinfocenterpane} \membersection{wxAuiPaneInfo::CenterPane}\label{wxauipaneinfocenterpane}
\func{wxPaneInfo\&}{CenterPane}{\void} \func{wxAuiPaneInfo\&}{CenterPane}{\void}
\membersection{wxPaneInfo::Centre}\label{wxpaneinfocentre} \membersection{wxAuiPaneInfo::Centre}\label{wxauipaneinfocentre}
\func{wxPaneInfo\&}{Centre}{\void} \func{wxAuiPaneInfo\&}{Centre}{\void}
\membersection{wxPaneInfo::CentrePane}\label{wxpaneinfocentrepane} \membersection{wxAuiPaneInfo::CentrePane}\label{wxauipaneinfocentrepane}
\func{wxPaneInfo\&}{CentrePane}{\void} \func{wxAuiPaneInfo\&}{CentrePane}{\void}
\membersection{wxPaneInfo::CloseButton}\label{wxpaneinfoclosebutton} \membersection{wxAuiPaneInfo::CloseButton}\label{wxauipaneinfoclosebutton}
\func{wxPaneInfo\&}{CloseButton}{\param{bool }{visible = true}} \func{wxAuiPaneInfo\&}{CloseButton}{\param{bool }{visible = true}}
\membersection{wxPaneInfo::DefaultPane}\label{wxpaneinfodefaultpane} \membersection{wxAuiPaneInfo::DefaultPane}\label{wxauipaneinfodefaultpane}
\func{wxPaneInfo\&}{DefaultPane}{\void} \func{wxAuiPaneInfo\&}{DefaultPane}{\void}
\membersection{wxPaneInfo::DestroyOnClose}\label{wxpaneinfodestroyonclose} \membersection{wxAuiPaneInfo::DestroyOnClose}\label{wxauipaneinfodestroyonclose}
\func{wxPaneInfo\&}{DestroyOnClose}{\param{bool }{b = true}} \func{wxAuiPaneInfo\&}{DestroyOnClose}{\param{bool }{b = true}}
\membersection{wxPaneInfo::Direction}\label{wxpaneinfodirection} \membersection{wxAuiPaneInfo::Direction}\label{wxauipaneinfodirection}
\func{wxPaneInfo\&}{Direction}{\param{int }{direction}} \func{wxAuiPaneInfo\&}{Direction}{\param{int }{direction}}
\membersection{wxPaneInfo::Dock}\label{wxpaneinfodock} \membersection{wxAuiPaneInfo::Dock}\label{wxauipaneinfodock}
\func{wxPaneInfo\&}{Dock}{\void} \func{wxAuiPaneInfo\&}{Dock}{\void}
\membersection{wxPaneInfo::Dockable}\label{wxpaneinfodockable} \membersection{wxAuiPaneInfo::Dockable}\label{wxauipaneinfodockable}
\func{wxPaneInfo\&}{Dockable}{\param{bool }{b = true}} \func{wxAuiPaneInfo\&}{Dockable}{\param{bool }{b = true}}
\membersection{wxPaneInfo::Fixed}\label{wxpaneinfofixed} \membersection{wxAuiPaneInfo::Fixed}\label{wxauipaneinfofixed}
\func{wxPaneInfo\&}{Fixed}{\void} \func{wxAuiPaneInfo\&}{Fixed}{\void}
\membersection{wxPaneInfo::Float}\label{wxpaneinfofloat} \membersection{wxAuiPaneInfo::Float}\label{wxauipaneinfofloat}
\func{wxPaneInfo\&}{Float}{\void} \func{wxAuiPaneInfo\&}{Float}{\void}
\membersection{wxPaneInfo::Floatable}\label{wxpaneinfofloatable} \membersection{wxAuiPaneInfo::Floatable}\label{wxauipaneinfofloatable}
\func{wxPaneInfo\&}{Floatable}{\param{bool }{b = true}} \func{wxAuiPaneInfo\&}{Floatable}{\param{bool }{b = true}}
\membersection{wxPaneInfo::FloatingPosition}\label{wxpaneinfofloatingposition} \membersection{wxAuiPaneInfo::FloatingPosition}\label{wxauipaneinfofloatingposition}
\func{wxPaneInfo\&}{FloatingPosition}{\param{const wxPoint\& }{pos}} \func{wxAuiPaneInfo\&}{FloatingPosition}{\param{const wxPoint\& }{pos}}
\func{wxPaneInfo\&}{FloatingPosition}{\param{int }{x}, \param{int }{y}} \func{wxAuiPaneInfo\&}{FloatingPosition}{\param{int }{x}, \param{int }{y}}
\membersection{wxPaneInfo::FloatingSize}\label{wxpaneinfofloatingsize} \membersection{wxAuiPaneInfo::FloatingSize}\label{wxauipaneinfofloatingsize}
\func{wxPaneInfo\&}{FloatingSize}{\param{const wxSize\& }{size}} \func{wxAuiPaneInfo\&}{FloatingSize}{\param{const wxSize\& }{size}}
\func{wxPaneInfo\&}{FloatingSize}{\param{int }{x}, \param{int }{y}} \func{wxAuiPaneInfo\&}{FloatingSize}{\param{int }{x}, \param{int }{y}}
\membersection{wxPaneInfo::Gripper}\label{wxpaneinfogripper} \membersection{wxAuiPaneInfo::Gripper}\label{wxauipaneinfogripper}
\func{wxPaneInfo\&}{Gripper}{\param{bool }{visible = true}} \func{wxAuiPaneInfo\&}{Gripper}{\param{bool }{visible = true}}
\membersection{wxPaneInfo::GripperTop}\label{wxpaneinfogrippertop} \membersection{wxAuiPaneInfo::GripperTop}\label{wxauipaneinfogrippertop}
\func{wxPaneInfo\&}{GripperTop}{\param{bool }{attop = true}} \func{wxAuiPaneInfo\&}{GripperTop}{\param{bool }{attop = true}}
\membersection{wxPaneInfo::HasBorder}\label{wxpaneinfohasborder} \membersection{wxAuiPaneInfo::HasBorder}\label{wxauipaneinfohasborder}
\constfunc{bool}{HasBorder}{\void} \constfunc{bool}{HasBorder}{\void}
\membersection{wxPaneInfo::HasCaption}\label{wxpaneinfohascaption} \membersection{wxAuiPaneInfo::HasCaption}\label{wxauipaneinfohascaption}
\constfunc{bool}{HasCaption}{\void} \constfunc{bool}{HasCaption}{\void}
\membersection{wxPaneInfo::HasCloseButton}\label{wxpaneinfohasclosebutton} \membersection{wxAuiPaneInfo::HasCloseButton}\label{wxauipaneinfohasclosebutton}
\constfunc{bool}{HasCloseButton}{\void} \constfunc{bool}{HasCloseButton}{\void}
\membersection{wxPaneInfo::HasFlag}\label{wxpaneinfohasflag} \membersection{wxAuiPaneInfo::HasFlag}\label{wxauipaneinfohasflag}
\constfunc{bool}{HasFlag}{\param{unsigned int }{flag}} \constfunc{bool}{HasFlag}{\param{unsigned int }{flag}}
\membersection{wxPaneInfo::HasGripper}\label{wxpaneinfohasgripper} \membersection{wxAuiPaneInfo::HasGripper}\label{wxauipaneinfohasgripper}
\constfunc{bool}{HasGripper}{\void} \constfunc{bool}{HasGripper}{\void}
\membersection{wxPaneInfo::HasGripperTop}\label{wxpaneinfohasgrippertop} \membersection{wxAuiPaneInfo::HasGripperTop}\label{wxauipaneinfohasgrippertop}
\constfunc{bool}{HasGripperTop}{\void} \constfunc{bool}{HasGripperTop}{\void}
\membersection{wxPaneInfo::HasMaximizeButton}\label{wxpaneinfohasmaximizebutton} \membersection{wxAuiPaneInfo::HasMaximizeButton}\label{wxauipaneinfohasmaximizebutton}
\constfunc{bool}{HasMaximizeButton}{\void} \constfunc{bool}{HasMaximizeButton}{\void}
\membersection{wxPaneInfo::HasMinimizeButton}\label{wxpaneinfohasminimizebutton} \membersection{wxAuiPaneInfo::HasMinimizeButton}\label{wxauipaneinfohasminimizebutton}
\constfunc{bool}{HasMinimizeButton}{\void} \constfunc{bool}{HasMinimizeButton}{\void}
\membersection{wxPaneInfo::HasPinButton}\label{wxpaneinfohaspinbutton} \membersection{wxAuiPaneInfo::HasPinButton}\label{wxauipaneinfohaspinbutton}
\constfunc{bool}{HasPinButton}{\void} \constfunc{bool}{HasPinButton}{\void}
\membersection{wxPaneInfo::Hide}\label{wxpaneinfohide} \membersection{wxAuiPaneInfo::Hide}\label{wxauipaneinfohide}
\func{wxPaneInfo\&}{Hide}{\void} \func{wxAuiPaneInfo\&}{Hide}{\void}
\membersection{wxPaneInfo::IsBottomDockable}\label{wxpaneinfoisbottomdockable} \membersection{wxAuiPaneInfo::IsBottomDockable}\label{wxauipaneinfoisbottomdockable}
\constfunc{bool}{IsBottomDockable}{\void} \constfunc{bool}{IsBottomDockable}{\void}
\membersection{wxPaneInfo::IsDocked}\label{wxpaneinfoisdocked} \membersection{wxAuiPaneInfo::IsDocked}\label{wxauipaneinfoisdocked}
\constfunc{bool}{IsDocked}{\void} \constfunc{bool}{IsDocked}{\void}
\membersection{wxPaneInfo::IsFixed}\label{wxpaneinfoisfixed} \membersection{wxAuiPaneInfo::IsFixed}\label{wxauipaneinfoisfixed}
\constfunc{bool}{IsFixed}{\void} \constfunc{bool}{IsFixed}{\void}
\membersection{wxPaneInfo::IsFloatable}\label{wxpaneinfoisfloatable} \membersection{wxAuiPaneInfo::IsFloatable}\label{wxauipaneinfoisfloatable}
\constfunc{bool}{IsFloatable}{\void} \constfunc{bool}{IsFloatable}{\void}
\membersection{wxPaneInfo::IsFloating}\label{wxpaneinfoisfloating} \membersection{wxAuiPaneInfo::IsFloating}\label{wxauipaneinfoisfloating}
\constfunc{bool}{IsFloating}{\void} \constfunc{bool}{IsFloating}{\void}
\membersection{wxPaneInfo::IsLeftDockable}\label{wxpaneinfoisleftdockable} \membersection{wxAuiPaneInfo::IsLeftDockable}\label{wxauipaneinfoisleftdockable}
\constfunc{bool}{IsLeftDockable}{\void} \constfunc{bool}{IsLeftDockable}{\void}
\membersection{wxPaneInfo::IsMovable}\label{wxpaneinfoismovable} \membersection{wxAuiPaneInfo::IsMovable}\label{wxauipaneinfoismovable}
\constfunc{bool}{IsMovable}{\void} \constfunc{bool}{IsMovable}{\void}
\membersection{wxPaneInfo::IsOk}\label{wxpaneinfoisok} \membersection{wxAuiPaneInfo::IsOk}\label{wxauipaneinfoisok}
\constfunc{bool}{IsOk}{\void} \constfunc{bool}{IsOk}{\void}
\membersection{wxPaneInfo::IsResizable}\label{wxpaneinfoisresizable} \membersection{wxAuiPaneInfo::IsResizable}\label{wxauipaneinfoisresizable}
\constfunc{bool}{IsResizable}{\void} \constfunc{bool}{IsResizable}{\void}
\membersection{wxPaneInfo::IsRightDockable}\label{wxpaneinfoisrightdockable} \membersection{wxAuiPaneInfo::IsRightDockable}\label{wxauipaneinfoisrightdockable}
\constfunc{bool}{IsRightDockable}{\void} \constfunc{bool}{IsRightDockable}{\void}
\membersection{wxPaneInfo::IsShown}\label{wxpaneinfoisshown} \membersection{wxAuiPaneInfo::IsShown}\label{wxauipaneinfoisshown}
\constfunc{bool}{IsShown}{\void} \constfunc{bool}{IsShown}{\void}
\membersection{wxPaneInfo::IsToolbar}\label{wxpaneinfoistoolbar} \membersection{wxAuiPaneInfo::IsToolbar}\label{wxauipaneinfoistoolbar}
\constfunc{bool}{IsToolbar}{\void} \constfunc{bool}{IsToolbar}{\void}
\membersection{wxPaneInfo::IsTopDockable}\label{wxpaneinfoistopdockable} \membersection{wxAuiPaneInfo::IsTopDockable}\label{wxauipaneinfoistopdockable}
\constfunc{bool}{IsTopDockable}{\void} \constfunc{bool}{IsTopDockable}{\void}
\membersection{wxPaneInfo::Layer}\label{wxpaneinfolayer} \membersection{wxAuiPaneInfo::Layer}\label{wxauipaneinfolayer}
\func{wxPaneInfo\&}{Layer}{\param{int }{layer}} \func{wxAuiPaneInfo\&}{Layer}{\param{int }{layer}}
\membersection{wxPaneInfo::Left}\label{wxpaneinfoleft} \membersection{wxAuiPaneInfo::Left}\label{wxauipaneinfoleft}
\func{wxPaneInfo\&}{Left}{\void} \func{wxAuiPaneInfo\&}{Left}{\void}
\membersection{wxPaneInfo::LeftDockable}\label{wxpaneinfoleftdockable} \membersection{wxAuiPaneInfo::LeftDockable}\label{wxauipaneinfoleftdockable}
\func{wxPaneInfo\&}{LeftDockable}{\param{bool }{b = true}} \func{wxAuiPaneInfo\&}{LeftDockable}{\param{bool }{b = true}}
\membersection{wxPaneInfo::MaxSize}\label{wxpaneinfomaxsize} \membersection{wxAuiPaneInfo::MaxSize}\label{wxauipaneinfomaxsize}
\func{wxPaneInfo\&}{MaxSize}{\param{const wxSize\& }{size}} \func{wxAuiPaneInfo\&}{MaxSize}{\param{const wxSize\& }{size}}
\func{wxPaneInfo\&}{MaxSize}{\param{int }{x}, \param{int }{y}} \func{wxAuiPaneInfo\&}{MaxSize}{\param{int }{x}, \param{int }{y}}
\membersection{wxPaneInfo::MaximizeButton}\label{wxpaneinfomaximizebutton} \membersection{wxAuiPaneInfo::MaximizeButton}\label{wxauipaneinfomaximizebutton}
\func{wxPaneInfo\&}{MaximizeButton}{\param{bool }{visible = true}} \func{wxAuiPaneInfo\&}{MaximizeButton}{\param{bool }{visible = true}}
\membersection{wxPaneInfo::MinSize}\label{wxpaneinfominsize} \membersection{wxAuiPaneInfo::MinSize}\label{wxauipaneinfominsize}
\func{wxPaneInfo\&}{MinSize}{\param{const wxSize\& }{size}} \func{wxAuiPaneInfo\&}{MinSize}{\param{const wxSize\& }{size}}
\func{wxPaneInfo\&}{MinSize}{\param{int }{x}, \param{int }{y}} \func{wxAuiPaneInfo\&}{MinSize}{\param{int }{x}, \param{int }{y}}
\membersection{wxPaneInfo::MinimizeButton}\label{wxpaneinfominimizebutton} \membersection{wxAuiPaneInfo::MinimizeButton}\label{wxauipaneinfominimizebutton}
\func{wxPaneInfo\&}{MinimizeButton}{\param{bool }{visible = true}} \func{wxAuiPaneInfo\&}{MinimizeButton}{\param{bool }{visible = true}}
\membersection{wxPaneInfo::Movable}\label{wxpaneinfomovable} \membersection{wxAuiPaneInfo::Movable}\label{wxauipaneinfomovable}
\func{wxPaneInfo\&}{Movable}{\param{bool }{b = true}} \func{wxAuiPaneInfo\&}{Movable}{\param{bool }{b = true}}
\membersection{wxPaneInfo::Name}\label{wxpaneinfoname} \membersection{wxAuiPaneInfo::Name}\label{wxauipaneinfoname}
\func{wxPaneInfo\&}{Name}{\param{const wxString\& }{n}} \func{wxAuiPaneInfo\&}{Name}{\param{const wxString\& }{n}}
\membersection{wxPaneInfo::PaneBorder}\label{wxpaneinfopaneborder} \membersection{wxAuiPaneInfo::PaneBorder}\label{wxauipaneinfopaneborder}
\func{wxPaneInfo\&}{PaneBorder}{\param{bool }{visible = true}} \func{wxAuiPaneInfo\&}{PaneBorder}{\param{bool }{visible = true}}
\membersection{wxPaneInfo::PinButton}\label{wxpaneinfopinbutton} \membersection{wxAuiPaneInfo::PinButton}\label{wxauipaneinfopinbutton}
\func{wxPaneInfo\&}{PinButton}{\param{bool }{visible = true}} \func{wxAuiPaneInfo\&}{PinButton}{\param{bool }{visible = true}}
\membersection{wxPaneInfo::Position}\label{wxpaneinfoposition} \membersection{wxAuiPaneInfo::Position}\label{wxauipaneinfoposition}
\func{wxPaneInfo\&}{Position}{\param{int }{pos}} \func{wxAuiPaneInfo\&}{Position}{\param{int }{pos}}
\membersection{wxPaneInfo::Resizable}\label{wxpaneinforesizable} \membersection{wxAuiPaneInfo::Resizable}\label{wxauipaneinforesizable}
\func{wxPaneInfo\&}{Resizable}{\param{bool }{resizable = true}} \func{wxAuiPaneInfo\&}{Resizable}{\param{bool }{resizable = true}}
\membersection{wxPaneInfo::Right}\label{wxpaneinforight} \membersection{wxAuiPaneInfo::Right}\label{wxauipaneinforight}
\func{wxPaneInfo\&}{Right}{\void} \func{wxAuiPaneInfo\&}{Right}{\void}
\membersection{wxPaneInfo::RightDockable}\label{wxpaneinforightdockable} \membersection{wxAuiPaneInfo::RightDockable}\label{wxauipaneinforightdockable}
\func{wxPaneInfo\&}{RightDockable}{\param{bool }{b = true}} \func{wxAuiPaneInfo\&}{RightDockable}{\param{bool }{b = true}}
\membersection{wxPaneInfo::Row}\label{wxpaneinforow} \membersection{wxAuiPaneInfo::Row}\label{wxauipaneinforow}
\func{wxPaneInfo\&}{Row}{\param{int }{row}} \func{wxAuiPaneInfo\&}{Row}{\param{int }{row}}
\membersection{wxPaneInfo::SafeSet}\label{wxpaneinfosafeset} \membersection{wxAuiPaneInfo::SafeSet}\label{wxauipaneinfosafeset}
\func{void}{SafeSet}{\param{wxPaneInfo }{source}} \func{void}{SafeSet}{\param{wxAuiPaneInfo }{source}}
Write the safe parts of a newly loaded PaneInfo structure "source" into "this" Write the safe parts of a newly loaded PaneInfo structure "source" into "this"
used on loading perspectives etc. used on loading perspectives etc.
\membersection{wxPaneInfo::SetFlag}\label{wxpaneinfosetflag} \membersection{wxAuiPaneInfo::SetFlag}\label{wxauipaneinfosetflag}
\func{wxPaneInfo\&}{SetFlag}{\param{unsigned int }{flag}, \param{bool }{option\_state}} \func{wxAuiPaneInfo\&}{SetFlag}{\param{unsigned int }{flag}, \param{bool }{option\_state}}
\membersection{wxPaneInfo::Show}\label{wxpaneinfoshow} \membersection{wxAuiPaneInfo::Show}\label{wxauipaneinfoshow}
\func{wxPaneInfo\&}{Show}{\param{bool }{show = true}} \func{wxAuiPaneInfo\&}{Show}{\param{bool }{show = true}}
\membersection{wxPaneInfo::ToolbarPane}\label{wxpaneinfotoolbarpane} \membersection{wxAuiPaneInfo::ToolbarPane}\label{wxauipaneinfotoolbarpane}
\func{wxPaneInfo\&}{ToolbarPane}{\void} \func{wxAuiPaneInfo\&}{ToolbarPane}{\void}
\membersection{wxPaneInfo::Top}\label{wxpaneinfotop} \membersection{wxAuiPaneInfo::Top}\label{wxauipaneinfotop}
\func{wxPaneInfo\&}{Top}{\void} \func{wxAuiPaneInfo\&}{Top}{\void}
\membersection{wxPaneInfo::TopDockable}\label{wxpaneinfotopdockable} \membersection{wxAuiPaneInfo::TopDockable}\label{wxauipaneinfotopdockable}
\func{wxPaneInfo\&}{TopDockable}{\param{bool }{b = true}} \func{wxAuiPaneInfo\&}{TopDockable}{\param{bool }{b = true}}
\membersection{wxPaneInfo::Window}\label{wxpaneinfowindow} \membersection{wxAuiPaneInfo::Window}\label{wxauipaneinfowindow}
\func{wxPaneInfo\&}{Window}{\param{wxWindow* }{w}} \func{wxAuiPaneInfo\&}{Window}{\param{wxWindow* }{w}}
\membersection{wxPaneInfo::operator=}\label{wxpaneinfooperatorassign} \membersection{wxAuiPaneInfo::operator=}\label{wxauipaneinfooperatorassign}
\func{wxPaneInfo\& operator}{operator=}{\param{const wxPaneInfo\& }{c}} \func{wxAuiPaneInfo\& operator}{operator=}{\param{const wxAuiPaneInfo\& }{c}}

2
docs/latex/wx/taui.tex
View File

@@ -1,6 +1,6 @@
\section{wxAUI overview}\label{wxauioverview} \section{wxAUI overview}\label{wxauioverview}
Class: \helpref{wxFraneManager}{wxframemanager}, \helpref{wxPaneInfo}{wxpaneinfo} Class: \helpref{wxAuiManager}{wxauimanager}, \helpref{wxAuiPaneInfo}{wxauipaneinfo}
wxAUI stands for Advances User Interface and the wxAUI framework wxAUI stands for Advances User Interface and the wxAUI framework
aims to give its user a cutting edge interface for use with the aims to give its user a cutting edge interface for use with the