Documented new menu label functions

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

diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex
index 9d0bd9cb38e0637afbcd978d1fd7bdc7c1f059d8..b7e00593e3e056150ae181c6dc5a2d882feb2109 100644 (file)
--- a/docs/latex/wx/frame.tex
+++ b/docs/latex/wx/frame.tex
@@ -21,6 +21,10 @@ application windows.
 
 <wx/frame.h>
 
 
 <wx/frame.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}


@@ -34,7 +38,7 @@ 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,
 \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
 \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


@@ -61,6 +65,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.}
 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
 \end{twocollist}
 
 The default frame style is for normal, resizeable frames. To create a frame


@@ -157,16 +162,6 @@ Centres the frame on the display.
 
 \docparam{direction}{The parameter may be {\tt wxHORIZONTAL}, {\tt wxVERTICAL} or {\tt wxBOTH}.}
 
 
 \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
 \membersection{wxFrame::Create}\label{wxframecreate}
 
 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp


@@ -200,7 +195,7 @@ wxWidgets.}
 
 \wxheading{Return value}
 
 
 \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}
 
 
 \wxheading{Remarks}
 


@@ -220,7 +215,7 @@ Note that you can put controls and other windows on the status bar if you wish.
 
 \membersection{wxFrame::CreateToolBar}\label{wxframecreatetoolbar}
 
 
 \membersection{wxFrame::CreateToolBar}\label{wxframecreatetoolbar}
 

-\func{virtual wxToolBar*}{CreateToolBar}{\param{long}{ style = wxNO\_BORDER \pipe wxTB\_HORIZONTAL},
+\func{virtual wxToolBar*}{CreateToolBar}{\param{long}{ style = wxBORDER\_NONE \pipe wxTB\_HORIZONTAL},

  \param{wxWindowID}{ id = -1}, \param{const wxString\&}{ name = "toolBar"}}
 
 Creates a toolbar at the top or left of the frame.
  \param{wxWindowID}{ id = -1}, \param{const wxString\&}{ name = "toolBar"}}
 
 Creates a toolbar at the top or left of the frame.


@@ -237,7 +232,7 @@ wxWidgets.}
 
 \wxheading{Return value}
 
 
 \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}
 
 
 \wxheading{Remarks}
 


@@ -250,6 +245,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.
 
 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
 \wxheading{See also}
 
 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar},\rtfsp


@@ -368,6 +368,18 @@ implementation returns an instance of \helpref{wxToolBar}{wxtoolbar}.
 
 \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \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}
 \membersection{wxFrame::SendSizeEvent}\label{wxframesendsizeevent}
 
 \func{void}{SendSizeEvent}{\void}


@@ -480,7 +492,7 @@ Sets the widths of the fields in the status bar.
 
 \wxheading{Parameters}
 
 
 \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
 same used in \helpref{CreateStatusBar}{wxframecreatestatusbar}.}
 
 \docparam{widths}{Must contain an array of {\it n} integers, each of which is a status field width