projects / wxWidgets.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
docstring fix
[wxWidgets.git] / docs / latex / wx / mdi.tex
diff --git a/docs/latex/wx/mdi.tex b/docs/latex/wx/mdi.tex
index af241ab1175fd8da29d087b999f58601352b0820..f4ed04e3030020f6dfa3e6b22a3508d854486208 100644 (file)
--- a/docs/latex/wx/mdi.tex
+++ b/docs/latex/wx/mdi.tex
@@ -36,7 +36,7 @@ See also \helpref{window styles overview}{windowstyles}.
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 
-Although internally an MDI child frame is a child of the MDI client window, in wxWindows
+Although internally an MDI child frame is a child of the MDI client window, in wxWidgets
 you create it as a child of \helpref{wxMDIParentFrame}{wxmdiparentframe}. You can usually
 forget that the client window exists.
 
 you create it as a child of \helpref{wxMDIParentFrame}{wxmdiparentframe}. You can usually
 forget that the client window exists.
 
@@ -55,7 +55,7 @@ frame's own menubar will be displayed.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxMDIChildFrame::wxMDIChildFrame}\label{wxmdichildframeconstr}
+\membersection{wxMDIChildFrame::wxMDIChildFrame}\label{wxmdichildframector}
 
 \func{}{wxMDIChildFrame}{\void}
 
 
 \func{}{wxMDIChildFrame}{\void}
 
@@ -77,10 +77,10 @@ Constructor, creating the window.
 \docparam{title}{The caption to be displayed on the frame's title bar.}
 
 \docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by
 \docparam{title}{The caption to be displayed on the frame's title bar.}
 
 \docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by
-either the windowing system or wxWindows, depending on platform.}
+either the windowing system or wxWidgets, depending on platform.}
 
 \docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by
 
 \docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by
-either the windowing system or wxWindows, depending on platform.}
+either the windowing system or wxWidgets, depending on platform.}
 
 \docparam{style}{The window style. See \helpref{wxMDIChildFrame}{wxmdichildframe}.}
 
 
 \docparam{style}{The window style. See \helpref{wxMDIChildFrame}{wxmdichildframe}.}
 
@@ -96,7 +96,7 @@ None.
 
 \helpref{wxMDIChildFrame::Create}{wxmdichildframecreate}
 
 
 \helpref{wxMDIChildFrame::Create}{wxmdichildframecreate}
 
-\membersection{wxMDIChildFrame::\destruct{wxMDIChildFrame}}
+\membersection{wxMDIChildFrame::\destruct{wxMDIChildFrame}}\label{wxmdichildframedtor}
 
 \func{}{\destruct{wxMDIChildFrame}}{\void}
 
 
 \func{}{\destruct{wxMDIChildFrame}}{\void}
 
@@ -120,12 +120,12 @@ Activates this MDI child frame.
 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
 \param{const wxString\& }{name = ``frame"}}
 
 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
 \param{const wxString\& }{name = ``frame"}}
 
-Used in two-step frame construction. See \helpref{wxMDIChildFrame::wxMDIChildFrame}{wxmdichildframeconstr}\rtfsp
+Used in two-step frame construction. See \helpref{wxMDIChildFrame::wxMDIChildFrame}{wxmdichildframector}\rtfsp
 for further details.
 
 \membersection{wxMDIChildFrame::Maximize}\label{wxmdichildframemaximize}
 
 for further details.
 
 \membersection{wxMDIChildFrame::Maximize}\label{wxmdichildframemaximize}
 
-\func{void}{Maximize}{\void}
+\func{void}{Maximize}{\param{bool}{maximize}}
 
 Maximizes this MDI child frame.
 
 
 Maximizes this MDI child frame.
 
@@ -181,7 +181,7 @@ the active child is not maximized, and no border style when a child is maximized
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxMDIClientWindow::wxMDIClientWindow}\label{wxmdiclientwindowconstr}
+\membersection{wxMDIClientWindow::wxMDIClientWindow}\label{wxmdiclientwindowctor}
 
 \func{}{wxMDIClientWindow}{\void}
 
 
 \func{}{wxMDIClientWindow}{\void}
 
@@ -203,10 +203,10 @@ The second style of constructor is called within \helpref{wxMDIParentFrame::OnCr
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 
-\helpref{wxMDIParentFrame::wxMDIParentFrame}{wxmdiparentframeconstr},\rtfsp
+\helpref{wxMDIParentFrame::wxMDIParentFrame}{wxmdiparentframector},\rtfsp
 \helpref{wxMDIParentFrame::OnCreateClient}{wxmdiparentframeoncreateclient}
 
 \helpref{wxMDIParentFrame::OnCreateClient}{wxmdiparentframeoncreateclient}
 
-\membersection{wxMDIClientWindow::\destruct{wxMDIClientWindow}}
+\membersection{wxMDIClientWindow::\destruct{wxMDIClientWindow}}\label{wxmdiclientwindowdtor}
 
 \func{}{\destruct{wxMDIClientWindow}}{\void}
 
 
 \func{}{\destruct{wxMDIClientWindow}}{\void}
 
@@ -216,7 +216,7 @@ Destructor.
 
 \func{bool}{CreateClient}{\param{wxMDIParentFrame* }{parent}, \param{long}{ style = 0}}
 
 
 \func{bool}{CreateClient}{\param{wxMDIParentFrame* }{parent}, \param{long}{ style = 0}}
 
-Used in two-step frame construction. See \helpref{wxMDIClientWindow::wxMDIClientWindow}{wxmdiclientwindowconstr}\rtfsp
+Used in two-step frame construction. See \helpref{wxMDIClientWindow::wxMDIClientWindow}{wxmdiclientwindowctor}\rtfsp
 for further details.
 
 \section{\class{wxMDIParentFrame}}\label{wxmdiparentframe}
 for further details.
 
 \section{\class{wxMDIParentFrame}}\label{wxmdiparentframe}
@@ -241,7 +241,8 @@ and is used in many popular Windows applications, such as Microsoft Word(TM).
 There may be multiple MDI parent frames in a single application, but this probably only makes sense
 within programming development environments.
 
 There may be multiple MDI parent frames in a single application, but this probably only makes sense
 within programming development environments.
 
-Child frames may be either \helpref{wxMDIChildFrame}{wxmdichildframe}, or \helpref{wxFrame}{wxframe}.
+Child frames may be of class \helpref{wxMDIChildFrame}{wxmdichildframe} (contained
+within the parent frame) or \helpref{wxFrame}{wxframe} (shown as a top-level frame).
 
 An MDI parent frame always has a \helpref{wxMDIClientWindow}{wxmdiclientwindow} associated with it, which
 is the parent for MDI client frames.
 
 An MDI parent frame always has a \helpref{wxMDIClientWindow}{wxmdiclientwindow} associated with it, which
 is the parent for MDI client frames.
@@ -288,7 +289,7 @@ See also \helpref{window styles overview}{windowstyles}.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxMDIParentFrame::wxMDIParentFrame}\label{wxmdiparentframeconstr}
+\membersection{wxMDIParentFrame::wxMDIParentFrame}\label{wxmdiparentframector}
 
 \func{}{wxMDIParentFrame}{\void}
 
 
 \func{}{wxMDIParentFrame}{\void}
 
@@ -310,10 +311,10 @@ Constructor, creating the window.
 \docparam{title}{The caption to be displayed on the frame's title bar.}
 
 \docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by
 \docparam{title}{The caption to be displayed on the frame's title bar.}
 
 \docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by
-either the windowing system or wxWindows, depending on platform.}
+either the windowing system or wxWidgets, depending on platform.}
 
 \docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by
 
 \docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by
-either the windowing system or wxWindows, depending on platform.}
+either the windowing system or wxWidgets, depending on platform.}
 
 \docparam{style}{The window style. See \helpref{wxMDIParentFrame}{wxmdiparentframe}.}
 
 
 \docparam{style}{The window style. See \helpref{wxMDIParentFrame}{wxmdiparentframe}.}
 
@@ -335,7 +336,7 @@ the active child is not maximized, and no border style when a child is maximized
 \helpref{wxMDIParentFrame::Create}{wxmdiparentframecreate},\rtfsp
 \helpref{wxMDIParentFrame::OnCreateClient}{wxmdiparentframeoncreateclient}
 
 \helpref{wxMDIParentFrame::Create}{wxmdiparentframecreate},\rtfsp
 \helpref{wxMDIParentFrame::OnCreateClient}{wxmdiparentframeoncreateclient}
 
-\membersection{wxMDIParentFrame::\destruct{wxMDIParentFrame}}
+\membersection{wxMDIParentFrame::\destruct{wxMDIParentFrame}}\label{wxmdiparentframedtor}
 
 \func{}{\destruct{wxMDIParentFrame}}{\void}
 
 
 \func{}{\destruct{wxMDIParentFrame}}{\void}
 
@@ -391,7 +392,7 @@ Arranges the MDI child windows in a cascade.
 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE \pipe wxVSCROLL \pipe wxHSCROLL},\rtfsp
 \param{const wxString\& }{name = ``frame"}}
 
 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE \pipe wxVSCROLL \pipe wxHSCROLL},\rtfsp
 \param{const wxString\& }{name = ``frame"}}
 
-Used in two-step frame construction. See \helpref{wxMDIParentFrame::wxMDIParentFrame}{wxmdiparentframeconstr}\rtfsp
+Used in two-step frame construction. See \helpref{wxMDIParentFrame::wxMDIParentFrame}{wxmdiparentframector}\rtfsp
 for further details.
 
 \membersection{wxMDIParentFrame::GetClientSize}\label{wxmdiparentframegetclientsize}
 for further details.
 
 \membersection{wxMDIParentFrame::GetClientSize}\label{wxmdiparentframegetclientsize}
@@ -468,7 +469,7 @@ Returns the window being used as the toolbar for this frame.
 
 \constfunc{wxMenu*}{GetWindowMenu}{\void}
 
 
 \constfunc{wxMenu*}{GetWindowMenu}{\void}
 
-Returns the current Window menu (added by wxWindows to the menubar). This function
+Returns the current Window menu (added by wxWidgets to the menubar). This function
 is available under Windows only.
 
 \membersection{wxMDIParentFrame::OnCreateClient}\label{wxmdiparentframeoncreateclient}
 is available under Windows only.
 
 \membersection{wxMDIParentFrame::OnCreateClient}\label{wxmdiparentframeoncreateclient}
@@ -544,9 +545,12 @@ To remove the window completely, use the wxFRAME\_NO\_WINDOW\_MENU window style.
 
 \membersection{wxMDIParentFrame::Tile}\label{wxmdiparentframetile}
 
 
 \membersection{wxMDIParentFrame::Tile}\label{wxmdiparentframetile}
 
-\func{void}{Tile}{\void}
+\func{void}{Tile}{\param{wxOrientation}{ orient = wxHORIZONTAL}}
 
 
-Tiles the MDI child windows.
+Tiles the MDI child windows either horizontally or vertically depending on
+whether \arg{orient} is wxHORIZONTAL or wxVERTICAL.
+
+Currently only implemented for MSW, does nothing under the other platforms.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 
wxWidgets (Impactor)