wxaui documentation updates

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@42855 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/framemanager.tex b/docs/latex/wx/framemanager.tex
index a91c1642a92b23192f28eb5e7a6b7a306168771a..f02364e6060bbdf746909d21c53871aef675d07a 100644 (file)
--- a/docs/latex/wx/framemanager.tex
+++ b/docs/latex/wx/framemanager.tex
@@ -133,18 +133,16 @@ to be modified.
 
 \func{}{\destruct{wxFrameManager}}{\void}
 
 
 \func{}{\destruct{wxFrameManager}}{\void}
 

-

 \membersection{wxFrameManager::AddPane}\label{wxframemanageraddpane}
 
 \func{bool}{AddPane}{\param{wxWindow* }{window}, \param{const wxPaneInfo\& }{pane\_info}}
 
 \membersection{wxFrameManager::AddPane}\label{wxframemanageraddpane}
 
 \func{bool}{AddPane}{\param{wxWindow* }{window}, \param{const wxPaneInfo\& }{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 wxPaneInfo\& }{pane\_info}, \param{const wxPoint\& }{drop\_pos}}
 
 
 
 \func{bool}{AddPane}{\param{wxWindow* }{window}, \param{const wxPaneInfo\& }{pane\_info}, \param{const wxPoint\& }{drop\_pos}}
 
 

-\func{bool}{AddPane}{\param{wxWindow* }{window}, \param{int }{direction = wxLEFT}, \param{const wxString\& }{caption = wxEmptyString}}
-
-Tells the frame manager to start managing a child window. 
+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{wxFrameManager::DetachPane}\label{wxframemanagerdetachpane}
 


@@ -154,21 +152,6 @@ Tells the wxFrameManager to stop managing the pane specified by window.
 The window, if in a floated frame, is reparented to the frame managed
 by wxFrameManager.
 
 The window, if in a floated frame, is reparented to the frame managed
 by wxFrameManager.
 

-\membersection{wxFrameManager::DoDrop}\label{wxframemanagerdodrop}
-
-\func{bool}{DoDrop}{\param{wxDockInfoArray\& }{docks}, \param{wxPaneInfoArray\& }{panes}, \param{wxPaneInfo\& }{drop}, \param{const wxPoint\& }{pt}, \param{const wxPoint\& }{action\_offset = wxPoint(0,0)}}
-
-
-\membersection{wxFrameManager::DoFrameLayout}\label{wxframemanagerdoframelayout}
-
-\func{void}{DoFrameLayout}{\void}
-
-
-\membersection{wxFrameManager::DrawHintRect}\label{wxframemanagerdrawhintrect}
-
-\func{void}{DrawHintRect}{\param{wxWindow* }{pane\_window}, \param{const wxPoint\& }{pt}, \param{const wxPoint\& }{offset}}
-
-

 \membersection{wxFrameManager::GetAllPanes}\label{wxframemanagergetallpanes}
 
 \func{wxPaneInfoArray\&}{GetAllPanes}{\void}
 \membersection{wxFrameManager::GetAllPanes}\label{wxframemanagergetallpanes}
 
 \func{wxPaneInfoArray\&}{GetAllPanes}{\void}


@@ -181,11 +164,6 @@ Returns an array of all panes managed by the frame manager.
 
 Returns the current art provider being used.
 
 
 Returns the current art provider being used.
 

-\membersection{wxFrameManager::GetDockPixelOffset}\label{wxframemanagergetdockpixeloffset}
-
-\func{int}{GetDockPixelOffset}{\param{wxPaneInfo\& }{test}}
-
-

 \membersection{wxFrameManager::GetFlags}\label{wxframemanagergetflags}
 
 \constfunc{unsigned int}{GetFlags}{\void}
 \membersection{wxFrameManager::GetFlags}\label{wxframemanagergetflags}
 
 \constfunc{unsigned int}{GetFlags}{\void}


@@ -202,7 +180,9 @@ Returns the frame currently being managed by wxFrameManager.
 
 \func{wxPaneInfo\&}{GetPane}{\param{wxWindow* }{window}}
 
 
 \func{wxPaneInfo\&}{GetPane}{\param{wxWindow* }{window}}
 

-{\it GetPanel} is used to lookup a wxPaneInfo object
+\func{wxPaneInfo\&}{GetPane}{\param{const wxString\& }{name}}
+
+{\it GetPane} is used to lookup a wxPaneInfo object

 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
 change a pane's look, state or position. After one or more
 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
 change a pane's look, state or position. After one or more


@@ -211,28 +191,11 @@ 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 wxPaneInfo's IsOk() method will return false.
 
 (meaning the pane could not be found in the manager), a call to the
 returned wxPaneInfo's IsOk() method will return false.
 

-\func{wxPaneInfo\&}{GetPane}{\param{const wxString\& }{name}}
-
-
-\membersection{wxFrameManager::GetPanePart}\label{wxframemanagergetpanepart}
-
-\func{wxDockUIPart*}{GetPanePart}{\param{wxWindow* }{pane}}
-
-
-\membersection{wxFrameManager::GetPanePositionsAndSizes}\label{wxframemanagergetpanepositionsandsizes}
-
-\func{void}{GetPanePositionsAndSizes}{\param{wxDockInfo\& }{dock}, \param{wxArrayInt\& }{positions}, \param{wxArrayInt\& }{sizes}}
-
-

 \membersection{wxFrameManager::HideHint}\label{wxframemanagerhidehint}
 
 \func{void}{HideHint}{\void}
 
 \membersection{wxFrameManager::HideHint}\label{wxframemanagerhidehint}
 
 \func{void}{HideHint}{\void}
 

-
-\membersection{wxFrameManager::HitTest}\label{wxframemanagerhittest}
-
-\func{wxDockUIPart*}{HitTest}{\param{int }{x}, \param{int }{y}}
-
+HideHint() hides any docking hint that may be visible.

 
 \membersection{wxFrameManager::InsertPane}\label{wxframemanagerinsertpane}
 
 
 \membersection{wxFrameManager::InsertPane}\label{wxframemanagerinsertpane}
 


@@ -247,25 +210,11 @@ 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.
 
 parameter \arg{insert\_level} can take a value of wxAUI\_INSERT\_PANE, wxAUI\_INSERT\_ROW 
 or wxAUI\_INSERT\_DOCK.
 

-\membersection{wxFrameManager::LayoutAddDock}\label{wxframemanagerlayoutadddock}
-
-\func{void}{LayoutAddDock}{\param{wxSizer* }{container}, \param{wxDockInfo\& }{dock}, \param{wxDockUIPartArray\& }{uiparts}, \param{bool }{spacer\_only}}
-
-
-\membersection{wxFrameManager::LayoutAddPane}\label{wxframemanagerlayoutaddpane}
-
-\func{void}{LayoutAddPane}{\param{wxSizer* }{container}, \param{wxDockInfo\& }{dock}, \param{wxPaneInfo\& }{pane}, \param{wxDockUIPartArray\& }{uiparts}, \param{bool }{spacer\_only}}
-
-
-\membersection{wxFrameManager::LayoutAll}\label{wxframemanagerlayoutall}
-
-\func{wxSizer*}{LayoutAll}{\param{wxPaneInfoArray\& }{panes}, \param{wxDockInfoArray\& }{docks}, \param{wxDockUIPartArray\& }{uiparts}, \param{bool }{spacer\_only = false}}
-
-

 \membersection{wxFrameManager::LoadPaneInfo}\label{wxframemanagerloadpaneinfo}
 
 \func{void}{LoadPaneInfo}{\param{wxString }{pane\_part}, \param{wxPaneInfo\& }{pane}}
 
 \membersection{wxFrameManager::LoadPaneInfo}\label{wxframemanagerloadpaneinfo}
 
 \func{void}{LoadPaneInfo}{\param{wxString }{pane\_part}, \param{wxPaneInfo\& }{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{wxFrameManager::LoadPerspective}\label{wxframemanagerloadperspective}
 
 
 \membersection{wxFrameManager::LoadPerspective}\label{wxframemanagerloadperspective}
 


@@ -274,38 +223,17 @@ or wxAUI\_INSERT\_DOCK.
 Loads a saved perspective. If update is true, wxFrameManager::Update()
 is automatically invoked, thus realizing the saved perspective on screen.
 
 Loads a saved perspective. If update is true, wxFrameManager::Update()
 is automatically invoked, thus realizing the saved perspective on screen.
 

-\membersection{wxFrameManager::LookupPane}\label{wxframemanagerlookuppane}
-
-\func{wxPaneInfo\&}{LookupPane}{\param{wxWindow* }{window}}
-
-
-\func{wxPaneInfo\&}{LookupPane}{\param{const wxString\& }{name}}
-
-

 \membersection{wxFrameManager::ProcessDockResult}\label{wxframemanagerprocessdockresult}
 
 \func{bool}{ProcessDockResult}{\param{wxPaneInfo\& }{target}, \param{const wxPaneInfo\& }{new\_pos}}
 
 \membersection{wxFrameManager::ProcessDockResult}\label{wxframemanagerprocessdockresult}
 
 \func{bool}{ProcessDockResult}{\param{wxPaneInfo\& }{target}, \param{const wxPaneInfo\& }{new\_pos}}
 

-
-\membersection{wxFrameManager::ProcessMgrEvent}\label{wxframemanagerprocessmgrevent}
-
-\func{void}{ProcessMgrEvent}{\param{wxFrameManagerEvent\& }{event}}
-
-
-\membersection{wxFrameManager::Render}\label{wxframemanagerrender}
-
-\func{void}{Render}{\param{wxDC* }{dc}}
-
-
-\membersection{wxFrameManager::Repaint}\label{wxframemanagerrepaint}
-
-\func{void}{Repaint}{\param{wxDC* }{dc = NULL}}
-
+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}
 
 \func{wxString}{SavePaneInfo}{\param{wxPaneInfo\& }{pane}}
 
 
 \membersection{wxFrameManager::SavePaneInfo}\label{wxframemanagersavepaneinfo}
 
 \func{wxString}{SavePaneInfo}{\param{wxPaneInfo\& }{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{wxFrameManager::SavePerspective}\label{wxframemanagersaveperspective}
 
 
 \membersection{wxFrameManager::SavePerspective}\label{wxframemanagersaveperspective}
 


@@ -336,19 +264,19 @@ specifies options which allow the frame management behavior to be modified.
 
 \func{void}{SetManagedWindow}{\param{wxWindow* }{managed\_wnd}}
 
 
 \func{void}{SetManagedWindow}{\param{wxWindow* }{managed\_wnd}}
 

-Called to specify the frame which is to be managed by wxFrameManager.
+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.

 
 \membersection{wxFrameManager::ShowHint}\label{wxframemanagershowhint}
 
 \func{void}{ShowHint}{\param{const wxRect\& }{rect}}
 
 
 \membersection{wxFrameManager::ShowHint}\label{wxframemanagershowhint}
 
 \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{wxFrameManager::UnInit}\label{wxframemanageruninit}
 
 \func{void}{UnInit}{\void}
 
 
 \membersection{wxFrameManager::UnInit}\label{wxframemanageruninit}
 
 \func{void}{UnInit}{\void}
 

-Uninitializes the framework and should be called before a frame is
-destroyed. UnInit() is usually called in the managed wxFrame's destructor.
+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{wxFrameManager::Update}\label{wxframemanagerupdate}
 


@@ -361,19 +289,3 @@ the changes. In addition, any number of changes may be made to
 wxPaneInfo structures (retrieved with wxFrameManager::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.
 wxPaneInfo structures (retrieved with wxFrameManager::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.

-
-\membersection{wxFrameManager::UpdateButtonOnScreen}\label{wxframemanagerupdatebuttononscreen}
-
-\func{void}{UpdateButtonOnScreen}{\param{wxDockUIPart* }{button\_ui\_part}, \param{const wxMouseEvent\& }{event}}
-
-
-\membersection{wxFrameManager::wxDEPRECATED}\label{wxframemanagerwxdeprecated}
-
-\func{}{wxDEPRECATED}{\param{void }{SetFrame(wxFrame* frame)}}
-
-deprecated -- please use SetManagedWindow() and
-and GetManagedWindow() instead
-
-
-\func{}{wxDEPRECATED}{\param{wxFrame* GetFrame() }{const}}
-