]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/frame.tex
added missing brace after wxTB_NO_TOOLTIPS
[wxWidgets.git] / docs / latex / wx / frame.tex
index ba58e1fe8ce3d0b41c94bf38d4fa722fb728e42b..d14563616686547e3e23186bfe083d804379077b 100644 (file)
@@ -12,6 +12,7 @@ application windows.
 
 \wxheading{Derived from}
 
+\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
@@ -24,30 +25,71 @@ 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 \pipe wxCLIP\_CHILDREN}.}
 \twocolitem{\windowstyle{wxICONIZE}}{Display the frame iconized (minimized). Windows only. }
 \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the frame.}
-\twocolitem{\windowstyle{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxTHICK\_FRAME \pipe wxSYSTEM\_MENU \pipe wxCAPTION}.}
-\twocolitem{\windowstyle{wxMINIMIZE}}{Identical to {\bf wxICONIZE}. Windows only. }
-\twocolitem{\windowstyle{wxMINIMIZE\_BOX}}{Displays a minimize box on the frame. }
-\twocolitem{\windowstyle{wxMAXIMIZE}}{Displays the frame maximized. Windows only. }
-\twocolitem{\windowstyle{wxMAXIMIZE\_BOX}}{Displays a maximize box on the frame. }
-\twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{Stay on top of other windows. Windows only. }
-\twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu. }
-\twocolitem{\windowstyle{wxTHICK\_FRAME}}{Displays a thick frame around the window. Windows and Motif only.}
-\twocolitem{\windowstyle{wxSIMPLE\_BORDER}}{Displays no border or decorations. GTK and Windows only (?). }
-\twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window (Unix only).}
-\twocolitem{\windowstyle{wxFRAME\_FLOAT\_ON\_PARENT}}{Causes the frame to be above the parent window in the
-z-order and not shown in the taskbar. Without this style, frames are created as top-level windows that may be obscured by
-the parent window, and frame titles are shown in the taskbar. Windows only. }
-\twocolitem{\windowstyle{wxFRAME\_TOOL\_WINDOW}}{Causes a frame with a small titlebar to be created;
-the frame title does not appear in the taskbar. Windows only. }
+\twocolitem{\windowstyle{wxMINIMIZE}}{Identical to {\bf wxICONIZE}. Windows only.}
+\twocolitem{\windowstyle{wxMINIMIZE\_BOX}}{Displays a minimize box on the frame.}
+\twocolitem{\windowstyle{wxMAXIMIZE}}{Displays the frame maximized. Windows only.}
+\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.}
+\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 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
+users and thus it might be better to use this style only without
+wxMINIMIZE\_BOX style). In wxGTK, the flag is respected only if GTK+ is at
+least version 2.2 and the window manager supports 
+\urlref{\_NET\_WM\_STATE\_SKIP\_TASKBAR}{http://freedesktop.org/Standards/wm-spec/1.3/ar01s05.html} hint.
+Has no effect under other platforms.}
+\twocolitem{\windowstyle{wxFRAME\_FLOAT\_ON\_PARENT}}{The frame will always be
+on top of its parent (unlike wxSTAY\_ON\_TOP). A frame created with this style
+must have a non-NULL parent.}
+\twocolitem{\windowstyle{wxFRAME\_EX\_CONTEXTHELP}}{Under Windows, puts a query button on the
+caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets will send
+a wxEVT\_HELP event if the user clicked on an application window. {\it Note} that this is an extended
+style and must be set by calling \helpref{SetExtraStyle}{wxwindowsetextrastyle} before Create is called (two-step construction).
+You cannot use this style together with wxMAXIMIZE\_BOX or wxMINIMIZE\_BOX, so
+you should use\rtfsp
+{\tt wxDEFAULT\_FRAME\_STYLE \& ~ (wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the
+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
+which can not be resized by user, you may use the following combination of
+styles: {\tt wxDEFAULT\_FRAME\_STYLE \& ~ (wxRESIZE\_BORDER \pipe wxRESIZE\_BOX \pipe wxMAXIMIZE\_BOX)}.
+% Note: the space after the tilde is necessary or Tex2RTF complains.
+
 See also \helpref{window styles overview}{windowstyles}.
 
+\wxheading{Default event processing}
+
+wxFrame processes the following events:
+
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\helpref{wxEVT\_SIZE}{wxsizeevent}}{If the frame has exactly one
+child window, not counting the status and toolbar, this child is resized to
+take the entire frame client area. If two or more windows are present, they
+should be laid out explicitly either by manually handling wxEVT\_SIZE or using
+\helpref{sizers}{sizeroverview}}
+
+\twocolitem{\helpref{wxEVT\_MENU\_HIGHLIGHT}{wxmenuevent}}{The default
+implementation displays the \helpref{help string}{wxmenuitemgethelp} associated
+with the selected item in the first pane of the status bar, if there is one.}
+\end{twocollist}
+
 \wxheading{Remarks}
 
-An application should normally define an \helpref{OnCloseWindow}{wxwindowonclosewindow} handler for the
+An application should normally define an \helpref{wxCloseEvent}{wxcloseevent} handler for the
 frame to respond to system close events, for example so that related data and subwindows can be cleaned up.
 
 \wxheading{See also}
@@ -57,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}
 
@@ -80,10 +122,10 @@ always be displayed on top of the parent window on Windows.}
 \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
-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{wxFrame}{wxframe}.}
 
@@ -100,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}
 
@@ -116,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
@@ -133,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}
@@ -153,13 +185,13 @@ value greater than 1 to create a multi-field status bar.}
 of valid styles.}
 
 \docparam{id}{The status bar window identifier. If -1, an identifier will be chosen by
-wxWindows.}
+wxWidgets.}
 
 \docparam{name}{The status bar window name.}
 
 \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}
 
@@ -190,13 +222,13 @@ Creates a toolbar at the top or left of the frame.
 of valid styles.}
 
 \docparam{id}{The toolbar window identifier. If -1, an identifier will be chosen by
-wxWindows.}
+wxWidgets.}
 
 \docparam{name}{The toolbar window name.}
 
 \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}
 
@@ -209,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
@@ -235,7 +272,7 @@ Returns a pointer to the menubar currently associated with the frame (if any).
 
 \membersection{wxFrame::GetStatusBar}\label{wxframegetstatusbar}
 
-\func{wxStatusBar*}{GetStatusBar}{\void}
+\constfunc{wxStatusBar*}{GetStatusBar}{\void}
 
 Returns a pointer to the status bar currently associated with the frame (if any).
 
@@ -243,16 +280,19 @@ Returns a pointer to the status bar currently associated with the frame (if any)
 
 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}
 
-\membersection{wxFrame::GetTitle}\label{wxframegettitle}
+\membersection{wxFrame::GetStatusBarPane}\label{wxframegetstatusbarpane}
 
-\func{wxString\&}{GetTitle}{\void}
+\func{int}{GetStatusBarPane}{\void}
 
-Gets a temporary pointer to the frame title. See
-\helpref{wxFrame::SetTitle}{wxframesettitle}.
+Returns the status bar pane used to display menu and toolbar help.
+
+\wxheading{See also}
+
+\helpref{wxFrame::SetStatusBarPane}{wxframesetstatusbarpane}
 
 \membersection{wxFrame::GetToolBar}\label{wxframegettoolbar}
 
-\func{wxToolBar*}{GetToolBar}{\void}
+\constfunc{wxToolBar*}{GetToolBar}{\void}
 
 Returns a pointer to the toolbar currently associated with the frame (if any).
 
@@ -261,57 +301,6 @@ Returns a pointer to the toolbar currently associated with the frame (if any).
 \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar},\rtfsp
 \helpref{wxFrame::SetToolBar}{wxframesettoolbar}
 
-\membersection{wxFrame::Iconize}\label{wxframeiconize}
-
-\func{void}{Iconize}{\param{const bool}{ iconize}}
-
-Iconizes or restores the frame. Windows only.
-
-\wxheading{Parameters}
-
-\docparam{izonize}{If TRUE, iconizes the frame; if FALSE, shows and restores it.}
-
-\wxheading{See also}
-
-\helpref{wxFrame::IsIconized}{wxframeisiconized}, \helpref{wxFrame::Maximize}{wxframemaximize}.
-
-\membersection{wxFrame::IsIconized}\label{wxframeisiconized}
-
-\constfunc{bool}{IsIconized}{\void}
-
-Returns TRUE if the frame is iconized. Windows only.
-
-\membersection{wxFrame::IsMaximized}\label{wxframeismaximized}
-
-\constfunc{bool}{IsMaximized}{\void}
-
-Returns TRUE if the frame is maximized.
-
-\membersection{wxFrame::Maximize}\label{wxframemaximize}
-
-\func{void}{Maximize}{\param{const bool }{maximize}}
-
-Maximizes or restores the frame.
-
-\wxheading{Parameters}
-
-\docparam{maximize}{If TRUE, maximizes the frame, otherwise it restores it}.
-
-\wxheading{Remarks}
-
-This function only works under Windows.
-
-\wxheading{See also}
-
-\helpref{wxFrame::Iconize}{wxframeiconize}
-
-\membersection{wxFrame::OnActivate}
-
-\func{void}{OnActivate}{\param{wxActivateEvent\&}{ event}}
-
-Called when a window is activated or deactivated (MS Windows
-only). See also \helpref{wxActivateEvent}{wxactivateevent}.
-
 \membersection{wxFrame::OnCreateStatusBar}\label{wxframeoncreatestatusbar}
 
 \func{virtual wxStatusBar*}{OnCreateStatusBar}{\param{int }{number},
@@ -328,7 +317,7 @@ Virtual function called when a status bar is requested by \helpref{wxFrame::Crea
 of valid styles.}
 
 \docparam{id}{The window identifier. If -1, an identifier will be chosen by
-wxWindows.}
+wxWidgets.}
 
 \docparam{name}{The window name.}
 
@@ -358,7 +347,7 @@ Virtual function called when a toolbar is requested by \helpref{wxFrame::CreateT
 of valid styles.}
 
 \docparam{id}{The toolbar window identifier. If -1, an identifier will be chosen by
-wxWindows.}
+wxWidgets.}
 
 \docparam{name}{The toolbar window name.}
 
@@ -375,77 +364,57 @@ implementation returns an instance of \helpref{wxToolBar}{wxtoolbar}.
 
 \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar}.
 
-\membersection{wxFrame::OnMenuCommand}\label{wxframeonmenucommand}
-
-\func{void}{OnMenuCommand}{\param{wxCommandEvent\&}{ event}}
-
-See \helpref{wxWindow::OnMenuCommand}{wxwindowonmenucommand}.
 
-\membersection{wxFrame::OnMenuHighlight}\label{wxframeonmenuhighlight}
+\membersection{wxFrame::ProcessCommand}\label{wxframeprocesscommand}
 
-\func{void}{OnMenuHighlight}{\param{wxMenuEvent\&}{ event}}
+\func{void}{ProcessCommand}{\param{int }{id}}
 
-See \helpref{wxWindow::OnMenuHighlight}{wxwindowonmenuhighlight}.
-
-\membersection{wxFrame::OnSize}\label{wxframeonsize}
-
-\func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
-
-See \helpref{wxWindow::OnSize}{wxwindowonsize}.
-
-The default {\bf wxFrame::OnSize} implementation looks for a single subwindow,
-and if one is found, resizes it to fit
-inside the frame. Override this member if more complex behaviour
-is required (for example, if there are several subwindows).
-
-\membersection{wxFrame::SetIcon}\label{wxframeseticon}
-
-\func{void}{SetIcon}{\param{const wxIcon\& }{icon}}
-
-Sets the icon for this frame.
+Simulate a menu command.
 
 \wxheading{Parameters}
 
-\docparam{icon}{The icon to associate with this frame.}
-
-\wxheading{Remarks}
-
-The frame takes a `copy' of {\it icon}, but since it uses reference
-counting, the copy is very quick. It is safe to delete {\it icon} after
-calling this function.
-
-Under Windows, instead of using {\bf SetIcon}, you can add the
-following lines to your MS Windows resource file:
-
-\begin{verbatim}
-wxSTD_MDIPARENTFRAME ICON icon1.ico
-wxSTD_MDICHILDFRAME  ICON icon2.ico
-wxSTD_FRAME          ICON icon3.ico
-\end{verbatim}
-
-where icon1.ico will be used for the MDI parent frame, icon2.ico
-will be used for MDI child frames, and icon3.ico will be used for
-non-MDI frames.
-
-If these icons are not supplied, and {\bf SetIcon} is not called either,
-then the following defaults apply if you have included wx.rc.
-
-\begin{verbatim}
-wxDEFAULT_FRAME               ICON std.ico
-wxDEFAULT_MDIPARENTFRAME      ICON mdi.ico
-wxDEFAULT_MDICHILDFRAME       ICON child.ico
-\end{verbatim}
-
-You can replace std.ico, mdi.ico and child.ico with your own defaults
-for all your wxWindows application. Currently they show the same icon.
+\docparam{id}{The identifier for a menu item.}
 
-{\it Note:} a wxWindows application linked with subsystem equal to 4.0
-(i.e. marked as a Windows 95 application) doesn't respond properly
-to wxFrame::SetIcon. To work around this until a solution is found,
-mark your program as a 3.5 application. This will also ensure
-that Windows provides small icons for the application automatically.
 
-See also \helpref{wxIcon}{wxicon}.
+\membersection{wxFrame::SendSizeEvent}\label{wxframesendsizeevent}
+
+\func{void}{SendSizeEvent}{\void}
+
+This function sends a dummy \helpref{size event}{wxsizeevent} to the frame
+forcing it to reevaluate its children positions. It is sometimes useful to call
+this function after adding or deleting a children after the frame creation or
+if a child size changes.
+
+Note that if the frame is using either sizers or constraints for the children
+layout, it is enough to call \helpref{Layout()}{wxwindowlayout} directly and
+this function should not be used in this case.
+
+% VZ: we don't have all this any more (18.08.00)
+%
+%Under Windows, instead of using {\bf SetIcon}, you can add the
+%following lines to your MS Windows resource file:
+%
+%\begin{verbatim}
+%wxSTD_MDIPARENTFRAME ICON icon1.ico
+%wxSTD_MDICHILDFRAME  ICON icon2.ico
+%wxSTD_FRAME          ICON icon3.ico
+%\end{verbatim}
+%
+%where icon1.ico will be used for the MDI parent frame, icon2.ico
+%will be used for MDI child frames, and icon3.ico will be used for
+%non-MDI frames.
+%
+%If these icons are not supplied, and {\bf SetIcon} is not called either,
+%then the following defaults apply if you have included wx.rc.
+%
+%\begin{verbatim}
+%wxDEFAULT_FRAME               ICON std.ico
+%wxDEFAULT_MDIPARENTFRAME      ICON mdi.ico
+%wxDEFAULT_MDICHILDFRAME       ICON child.ico
+%\end{verbatim}
+%
+%You can replace std.ico, mdi.ico and child.ico with your own defaults
+%for all your wxWidgets application. Currently they show the same icon.
 
 \membersection{wxFrame::SetMenuBar}\label{wxframesetmenubar}
 
@@ -464,10 +433,10 @@ menu bar and its menus will be destroyed also, so do not delete the menu
 bar explicitly (except by resetting the frame's menu bar to another
 frame or NULL).
 
-Under Windows, a call to \helpref{wxFrame::OnSize}{wxframeonsize} is generated, so be sure to initialize
+Under Windows, a size event is generated, so be sure to initialize
 data members properly before calling {\bf SetMenuBar}.
 
-Note that it is not possible to call this function twice for the same frame object.
+Note that on some platforms, it is not possible to call this function twice for the same frame object.
 
 \wxheading{See also}
 
@@ -484,6 +453,13 @@ Associates a status bar with the frame.
 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar},\rtfsp
 \helpref{wxFrame::GetStatusBar}{wxframegetstatusbar}
 
+\membersection{wxFrame::SetStatusBarPane}\label{wxframesetstatusbarpane}
+
+\func{void}{SetStatusBarPane}{\param{int}{ n}}
+
+Set the status bar pane used to display menu and toolbar help.
+Using -1 disables help display.
+
 \membersection{wxFrame::SetStatusText}\label{wxframesetstatustext}
 
 \func{virtual void}{SetStatusText}{\param{const wxString\& }{ text}, \param{int}{ number = 0}}
@@ -512,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
@@ -528,6 +504,7 @@ variable fields.
 \pythonnote{Only a single parameter is required, a Python list of
 integers.}
 
+\perlnote{In wxPerl this method takes the field widths as parameters.}
 
 \membersection{wxFrame::SetToolBar}\label{wxframesettoolbar}
 
@@ -540,17 +517,3 @@ Associates a toolbar with the frame.
 \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar},\rtfsp
 \helpref{wxFrame::GetToolBar}{wxframegettoolbar}
 
-\membersection{wxFrame::SetTitle}\label{wxframesettitle}
-
-\func{virtual void}{SetTitle}{\param{const wxString\& }{ title}}
-
-Sets the frame title.
-
-\wxheading{Parameters}
-
-\docparam{title}{The frame title.}
-
-\wxheading{See also}
-
-\helpref{wxFrame::GetTitle}{wxframegettitle}
-