X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f0e8a2d07799ba3a8d03487dfc181d7f5a38a2ad..4fcbc84d657413b157ac3ef89bf8fbccbcf899ba:/docs/latex/wx/frame.tex diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex index d41636143a..b7e00593e3 100644 --- a/docs/latex/wx/frame.tex +++ b/docs/latex/wx/frame.tex @@ -21,6 +21,10 @@ application windows. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Window styles} \twocolwidtha{5cm} @@ -34,11 +38,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 +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.} +\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 @@ -157,16 +162,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 @@ -200,7 +195,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} @@ -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} -\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. @@ -237,7 +232,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 +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. +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 +368,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 +492,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