patch 1306473

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

diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex
index ffa74eefcf2f135b0f897152a46aa8b0ef6071d4..d14563616686547e3e23186bfe083d804379077b 100644 (file)
--- a/docs/latex/wx/frame.tex
+++ b/docs/latex/wx/frame.tex
@@ -25,7 +25,7 @@ application windows.
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{\windowstyle{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxRESIZE\_BORDER \pipe wxSYSTEM\_MENU \pipe wxCAPTION \pipe wxCLOSE\_BOX}.}
+\twocolitem{\windowstyle{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxRESIZE\_BORDER \pipe wxSYSTEM\_MENU \pipe wxCAPTION \pipe wxCLOSE\_BOX \pipe wxCLIP\_CHILDREN}.}
 \twocolitem{\windowstyle{wxICONIZE}}{Display the frame iconized (minimized). Windows only. }
 \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the frame.}
 \twocolitem{\windowstyle{wxMINIMIZE}}{Identical to {\bf wxICONIZE}. Windows only.}
@@ -34,11 +34,11 @@ application windows.
 \twocolitem{\windowstyle{wxMAXIMIZE\_BOX}}{Displays a maximize box on the frame.}
 \twocolitem{\windowstyle{wxCLOSE\_BOX}}{Displays a close box on the frame.}
 \twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{Stay on top of all other windows,
-see also wxFRAME\_FLOAT\_ON\_PARENT. Windows only.}
+see also wxFRAME\_FLOAT\_ON\_PARENT.}
 \twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu.}
 \twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window.}
 \twocolitem{\windowstyle{wxFRAME\_TOOL\_WINDOW}}{Causes a frame with a small
-titlebar to be created; the frame does not appear in the taskbar under Windows.}
+titlebar to be created; the frame does not appear in the taskbar under Windows or GTK+.}
 \twocolitem{\windowstyle{wxFRAME\_NO\_TASKBAR}}{Creates an otherwise normal
 frame but it does not appear in the taskbar under Windows or GTK+ (note that it
 will minimize to the desktop window under Windows which may seem strange to the
@@ -61,6 +61,7 @@ frames having this style (the dialogs don't have a minimize or a maximize box by
 default)}
 \twocolitem{\windowstyle{wxFRAME\_SHAPED}}{Windows with this style are
   allowed to have their shape changed with the \helpref{SetShape}{wxtoplevelwindowsetshape} method.}
+\twocolitem{\windowstyle{wxFRAME\_EX\_METAL}}{On Mac OS X, frames with this style will be shown with a metallic look. This is an {\it extra} style.}
 \end{twocollist}
 
 The default frame style is for normal, resizeable frames. To create a frame
@@ -98,7 +99,7 @@ frame to respond to system close events, for example so that related data and su
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxFrame::wxFrame}\label{wxframeconstr}
+\membersection{wxFrame::wxFrame}\label{wxframector}
 
 \func{}{wxFrame}{\void}
 
@@ -141,7 +142,7 @@ For Motif, MWM (the Motif Window Manager) should be running for any window style
 
 \helpref{wxFrame::Create}{wxframecreate}
 
-\membersection{wxFrame::\destruct{wxFrame}}
+\membersection{wxFrame::\destruct{wxFrame}}\label{wxframedtor}
 
 \func{void}{\destruct{wxFrame}}{\void}
 
@@ -157,16 +158,6 @@ Centres the frame on the display.
 
 \docparam{direction}{The parameter may be {\tt wxHORIZONTAL}, {\tt wxVERTICAL} or {\tt wxBOTH}.}
 
-\membersection{wxFrame::Command}\label{wxframecommand}
-
-\func{void}{Command}{\param{int }{id}}
-
-Simulate a menu command.
-
-\wxheading{Parameters}
-
-\docparam{id}{The identifier for a menu item.}
-
 \membersection{wxFrame::Create}\label{wxframecreate}
 
 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
@@ -174,7 +165,7 @@ Simulate a menu command.
 \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{wxFrame::wxFrame}{wxframeconstr}\rtfsp
+Used in two-step frame construction. See \helpref{wxFrame::wxFrame}{wxframector}\rtfsp
 for further details.
 
 \membersection{wxFrame::CreateStatusBar}\label{wxframecreatestatusbar}
@@ -200,7 +191,7 @@ wxWidgets.}
 
 \wxheading{Return value}
 
-A pointer to the the status bar if it was created successfully, NULL otherwise.
+A pointer to the status bar if it was created successfully, NULL otherwise.
 
 \wxheading{Remarks}
 
@@ -237,7 +228,7 @@ wxWidgets.}
 
 \wxheading{Return value}
 
-A pointer to the the toolbar if it was created successfully, NULL otherwise.
+A pointer to the toolbar if it was created successfully, NULL otherwise.
 
 \wxheading{Remarks}
 
@@ -250,6 +241,11 @@ with \helpref{wxFrame::SetToolBar}{wxframesettoolbar}, the frame will manage the
 position and adjust the return value from \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} to
 reflect the available space for application windows.
 
+Under Pocket PC, you should {\it always} use this function for creating the toolbar
+to be managed by the frame, so that wxWidgets can use a combined
+menubar and toolbar. Where you manage your own toolbars, create a wxToolBar
+as usual.
+
 \wxheading{See also}
 
 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar},\rtfsp
@@ -368,6 +364,18 @@ implementation returns an instance of \helpref{wxToolBar}{wxtoolbar}.
 
 \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar}.
 
+
+\membersection{wxFrame::ProcessCommand}\label{wxframeprocesscommand}
+
+\func{void}{ProcessCommand}{\param{int }{id}}
+
+Simulate a menu command.
+
+\wxheading{Parameters}
+
+\docparam{id}{The identifier for a menu item.}
+
+
 \membersection{wxFrame::SendSizeEvent}\label{wxframesendsizeevent}
 
 \func{void}{SendSizeEvent}{\void}
@@ -480,7 +488,7 @@ Sets the widths of the fields in the status bar.
 
 \wxheading{Parameters}
 
-\wxheading{n}{The number of fields in the status bar. It must be the
+\docparam{n}{The number of fields in the status bar. It must be the
 same used in \helpref{CreateStatusBar}{wxframecreatestatusbar}.}
 
 \docparam{widths}{Must contain an array of {\it n} integers, each of which is a status field width