Fixed problem with Calltip tab not refreshing properly on Windows.

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

diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex
index 61cad1ee362a30f9b4b40a966107e87221f135f9..b35370d43131011eeec9be2d01d4ff41c00a529c 100644 (file)
--- a/docs/latex/wx/frame.tex
+++ b/docs/latex/wx/frame.tex
@@ -1,8 +1,14 @@
 \section{\class{wxFrame}}\label{wxframe}
 
 \section{\class{wxFrame}}\label{wxframe}
 

-A frame is a window whose size and position can (usually) be changed by the user. It usually has
-thick borders and a title bar, and can optionally contain a menu bar, toolbar and
-status bar. A frame can contain any window that is not a frame or dialog.
+A frame is a window whose size and position can (usually) be changed by the
+user. It usually has thick borders and a title bar, and can optionally contain
+a menu bar, toolbar and status bar. A frame can contain any window that is not
+a frame or dialog.
+
+A frame that has a status bar and toolbar created via the
+CreateStatusBar/CreateToolBar functions manages these windows, and adjusts the
+value returned by GetClientSize to reflect the remaining size available to
+application windows.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -10,28 +16,75 @@ status bar. A frame can contain any window that is not a frame or dialog.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/frame.h>
+

 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt

-\twocolitem{\windowstyle{wxICONIZE}}{Display the frame iconized (minimized) (Windows only).}
+\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{wxICONIZE}}{Display the frame iconized (minimized). Windows only. }

 \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the frame.}
 \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}.}
-\twocolitem{\windowstyle{wxMINIMIZE\_BOX}}{Displays a minimize box on the frame (Windows and Motif only).}
-\twocolitem{\windowstyle{wxMAXIMIZE}}{Displays the frame maximized (Windows only).}
-\twocolitem{\windowstyle{wxMAXIMIZE\_BOX}}{Displays a maximize box on the frame (Windows and Motif only).}
-\twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{Stay on top of other windows (Windows only).}
-\twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu (Windows and Motif only).}
-\twocolitem{\windowstyle{wxTHICK\_FRAME}}{Displays a thick frame around the window (Windows and Motif only).}
-\twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window (Motif 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. Windows only.}
+\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.}
+\twocolitem{\windowstyle{wxFRAME\_NO\_TASKBAR}}{Creates an otherwise normal
+frame but it does not appear in the taskbar under Windows (note that it will
+minimize to the desktop window which may seem strange to the users and thus it
+might be better to use this style only without wxMINIMIZE\_BOX style).
+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 wxWindows 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
+{\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}{wxframesetshape} method.}

 \end{twocollist}
 
 \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}.
 
 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}
 
 \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}
 frame to respond to system close events, for example so that related data and subwindows can be cleaned up.
 
 \wxheading{See also}


@@ -47,7 +100,7 @@ frame to respond to system close events, for example so that related data and su
 
 Default constructor.
 
 
 Default constructor.
 

-\func{}{wxFrame}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp
+\func{}{wxFrame}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp

 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
 \param{const wxString\& }{name = ``frame"}}
 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
 \param{const wxString\& }{name = ``frame"}}


@@ -92,7 +145,7 @@ Destructor. Destroys all child windows and menu bar if present.
 
 \membersection{wxFrame::Centre}\label{wxframecentre}
 
 
 \membersection{wxFrame::Centre}\label{wxframecentre}
 

-\func{void}{Centre}{\param{const int}{ direction = wxBOTH}}
+\func{void}{Centre}{\param{int}{ direction = wxBOTH}}

 
 Centres the frame on the display.
 
 
 Centres the frame on the display.
 


@@ -112,7 +165,7 @@ Simulate a menu command.
 
 \membersection{wxFrame::Create}\label{wxframecreate}
 
 
 \membersection{wxFrame::Create}\label{wxframecreate}
 

-\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp

 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
 \param{const wxString\& }{name = ``frame"}}
 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
 \param{const wxString\& }{name = ``frame"}}


@@ -122,7 +175,9 @@ for further details.
 
 \membersection{wxFrame::CreateStatusBar}\label{wxframecreatestatusbar}
 
 
 \membersection{wxFrame::CreateStatusBar}\label{wxframecreatestatusbar}
 

-\func{virtual bool}{CreateStatusBar}{\param{const int}{ number = 1}}
+\func{virtual wxStatusBar*}{CreateStatusBar}{\param{int}{ number = 1},
+ \param{long}{ style = 0},
+ \param{wxWindowID}{ id = -1}, \param{const wxString\&}{ name = "statusBar"}}

 
 Creates a status bar at the bottom of the frame.
 
 
 Creates a status bar at the bottom of the frame.
 


@@ -131,9 +186,17 @@ Creates a status bar at the bottom of the frame.
 \docparam{number}{The number of fields to create. Specify a
 value greater than 1 to create a multi-field status bar.}
 
 \docparam{number}{The number of fields to create. Specify a
 value greater than 1 to create a multi-field status bar.}
 

+\docparam{style}{The status bar style. See \helpref{wxStatusBar}{wxstatusbar} for a list
+of valid styles.}
+
+\docparam{id}{The status bar window identifier. If -1, an identifier will be chosen by
+wxWindows.}
+
+\docparam{name}{The status bar window name.}
+

 \wxheading{Return value}
 
 \wxheading{Return value}
 

-TRUE if the status bar was created successfully.
+A pointer to the the status bar if it was created successfully, NULL otherwise.

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -151,6 +214,52 @@ Note that you can put controls and other windows on the status bar if you wish.
 \helpref{wxFrame::OnCreateStatusBar}{wxframeoncreatestatusbar},\rtfsp
 \helpref{wxFrame::GetStatusBar}{wxframegetstatusbar}
 
 \helpref{wxFrame::OnCreateStatusBar}{wxframeoncreatestatusbar},\rtfsp
 \helpref{wxFrame::GetStatusBar}{wxframegetstatusbar}
 

+\membersection{wxFrame::CreateToolBar}\label{wxframecreatetoolbar}
+
+\func{virtual wxToolBar*}{CreateToolBar}{\param{long}{ style = wxNO\_BORDER \pipe wxTB\_HORIZONTAL},
+ \param{wxWindowID}{ id = -1}, \param{const wxString\&}{ name = "toolBar"}}
+
+Creates a toolbar at the top or left of the frame.
+
+\wxheading{Parameters}
+
+\docparam{style}{The toolbar style. See \helpref{wxToolBar}{wxtoolbar} for a list
+of valid styles.}
+
+\docparam{id}{The toolbar window identifier. If -1, an identifier will be chosen by
+wxWindows.}
+
+\docparam{name}{The toolbar window name.}
+
+\wxheading{Return value}
+
+A pointer to the the toolbar if it was created successfully, NULL otherwise.
+
+\wxheading{Remarks}
+
+By default, the toolbar is an instance of wxToolBar (which is defined to be
+a suitable toolbar class on each platform, such as wxToolBar95). To use a different class,
+override \helpref{wxFrame::OnCreateToolBar}{wxframeoncreatetoolbar}.
+
+When a toolbar has been created with this function, or made known to the frame
+with \helpref{wxFrame::SetToolBar}{wxframesettoolbar}, the frame will manage the toolbar
+position and adjust the return value from \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} to
+reflect the available space for application windows.
+
+\wxheading{See also}
+
+\helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar},\rtfsp
+\helpref{wxFrame::OnCreateToolBar}{wxframeoncreatetoolbar},\rtfsp
+\helpref{wxFrame::SetToolBar}{wxframesettoolbar},\rtfsp
+\helpref{wxFrame::GetToolBar}{wxframegettoolbar}
+
+\membersection{wxFrame::GetClientAreaOrigin}\label{wxframegetclientareaorigin}
+
+\constfunc{wxPoint}{GetClientAreaOrigin}{\void}
+
+Returns the origin of the frame client area (in client coordinates). It may be
+different from (0, 0) if the frame has a toolbar.
+

 \membersection{wxFrame::GetMenuBar}\label{wxframegetmenubar}
 
 \constfunc{wxMenuBar*}{GetMenuBar}{\void}
 \membersection{wxFrame::GetMenuBar}\label{wxframegetmenubar}
 
 \constfunc{wxMenuBar*}{GetMenuBar}{\void}


@@ -163,7 +272,7 @@ Returns a pointer to the menubar currently associated with the frame (if any).
 
 \membersection{wxFrame::GetStatusBar}\label{wxframegetstatusbar}
 
 
 \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).
 
 
 Returns a pointer to the status bar currently associated with the frame (if any).
 


@@ -171,79 +280,78 @@ Returns a pointer to the status bar currently associated with the frame (if any)
 
 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}
 
 
 \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.

 
 

-\membersection{wxFrame::Iconize}\label{wxframeiconize}
+\wxheading{See also}

 
 

-\func{void}{Iconize}{\param{const bool}{ iconize}}
+\helpref{wxFrame::SetStatusBarPane}{wxframesetstatusbarpane}

 
 

-Iconizes or restores the frame.
+\membersection{wxFrame::GetTitle}\label{wxframegettitle}

 
 

-\wxheading{Parameters}
+\constfunc{wxString}{GetTitle}{\void}

 
 

-\docparam{izonize}{If TRUE, iconizes the frame; if FALSE, shows and restores it.}
+Gets a string containing the frame title. See \helpref{wxFrame::SetTitle}{wxframesettitle}.

 
 

-\wxheading{See also}
+\membersection{wxFrame::GetToolBar}\label{wxframegettoolbar}

 
 

-\helpref{wxFrame::IsIconized}{wxframeisiconized}, \helpref{wxFrame::Maximize}{wxframemaximize}.
+\constfunc{wxToolBar*}{GetToolBar}{\void}

 
 

-\membersection{wxFrame::IsIconized}\label{wxframeisiconized}
+Returns a pointer to the toolbar currently associated with the frame (if any).

 
 

-\func{bool}{IsIconized}{\void}
+\wxheading{See also}

 
 

-Returns TRUE if the frame is iconized.
+\helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar},\rtfsp
+\helpref{wxFrame::SetToolBar}{wxframesettoolbar}

 
 

-\membersection{wxFrame::LoadAccelerators}\label{wxframeloadaccelerators}
+\membersection{wxFrame::Iconize}\label{wxframeiconize}

 
 

-\func{void}{LoadAccelerators}{\param{const wxString\& }{table}}
+\func{void}{Iconize}{\param{bool}{ iconize}}

 
 

-Loads a keyboard accelerator table for this frame.
+Iconizes or restores the frame.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{table}{Accelerator table to load.}
+\docparam{iconize}{If true, iconizes the frame; if false, shows and restores it.}

 
 

-\wxheading{Return value}
+\wxheading{See also}

 
 

-TRUE if the operation was successful, FALSE otherwise.
+\helpref{wxFrame::IsIconized}{wxframeisiconized}, \helpref{wxFrame::Maximize}{wxframemaximize}.

 
 

-\wxheading{Remarks}
+\membersection{wxFrame::IsFullScreen}\label{wxframeisfullscreen}
+
+\func{bool}{IsFullScreen}{\void}
+
+Returns true if the frame is in fullscreen mode.

 
 

-Accelerator tables map keystrokes onto control and menu identifiers, so the
-programmer does not have to explicitly program this correspondence.
+\wxheading{See also}

 
 

-See the hello demo ({\tt hello.cpp} and {\tt hello.rc}) for
-an example of accelerator usage. This is a fragment from {\tt hello.rc}:
+\helpref{wxFrame::ShowFullScreen}{wxframeshowfullscreen}

 
 

-\begin{verbatim}
-#define HELLO_LOAD_FILE  111
+\membersection{wxFrame::IsIconized}\label{wxframeisiconized}

 
 

-menus_accel ACCELERATORS
-{
+\constfunc{bool}{IsIconized}{\void}

 
 

-"^L", HELLO_LOAD_FILE
+Returns true if the frame is iconized.

 
 

-}
-\end{verbatim}
+\membersection{wxFrame::IsMaximized}\label{wxframeismaximized}

 
 

-This function only works under Windows.
+\constfunc{bool}{IsMaximized}{\void}

 
 

-% huh? If you call LoadAccelerators, you need to override wxFrame::OnActivate to do nothing.
+Returns true if the frame is maximized.

 
 \membersection{wxFrame::Maximize}\label{wxframemaximize}
 
 
 \membersection{wxFrame::Maximize}\label{wxframemaximize}
 

-\func{void}{Maximize}{\param{const bool }{maximize}}
+\func{void}{Maximize}{\param{bool }{maximize}}

 
 Maximizes or restores the frame.
 
 \wxheading{Parameters}
 
 
 Maximizes or restores the frame.
 
 \wxheading{Parameters}
 

-\docparam{maximize}{If TRUE, maximizes the frame, otherwise it restores it}.
+\docparam{maximize}{If true, maximizes the frame, otherwise it restores it.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -253,23 +361,11 @@ This function only works under Windows.
 
 \helpref{wxFrame::Iconize}{wxframeiconize}
 
 
 \helpref{wxFrame::Iconize}{wxframeiconize}
 

-\membersection{wxFrame::OnActivate}
-
-\func{void}{OnActivate}{\param{bool}{ active}}
-
-Called when a window is activated or deactivated (MS Windows
-only). If the window is being activated, {\it active} is TRUE, else it
-is FALSE.
-
-If you call wxFrame::LoadAccelerators, you need to override this function e.g.
-
-\begin{verbatim}
-   void OnActivate(bool) {};
-\end{verbatim}
-

 \membersection{wxFrame::OnCreateStatusBar}\label{wxframeoncreatestatusbar}
 
 \membersection{wxFrame::OnCreateStatusBar}\label{wxframeoncreatestatusbar}
 

-\func{virtual wxStatusBar*}{OnCreateStatusBar}{\param{const int }{number}}
+\func{virtual wxStatusBar*}{OnCreateStatusBar}{\param{int }{number},
+ \param{long}{ style},
+ \param{wxWindowID}{ id}, \param{const wxString\&}{ name}}

 
 Virtual function called when a status bar is requested by \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}.
 
 
 Virtual function called when a status bar is requested by \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}.
 


@@ -277,6 +373,14 @@ Virtual function called when a status bar is requested by \helpref{wxFrame::Crea
 
 \docparam{number}{The number of fields to create.}
 
 
 \docparam{number}{The number of fields to create.}
 

+\docparam{style}{The window style. See \helpref{wxStatusBar}{wxstatusbar} for a list
+of valid styles.}
+
+\docparam{id}{The window identifier. If -1, an identifier will be chosen by
+wxWindows.}
+
+\docparam{name}{The window name.}
+

 \wxheading{Return value}
 
 A status bar object.
 \wxheading{Return value}
 
 A status bar object.


@@ -290,28 +394,48 @@ implementation returns an instance of \helpref{wxStatusBar}{wxstatusbar}.
 
 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}.
 
 
 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}.
 

-\membersection{wxFrame::OnMenuCommand}\label{wxframeonmenucommand}
+\membersection{wxFrame::OnCreateToolBar}\label{wxframeoncreatetoolbar}

 
 

-\func{void}{OnMenuCommand}{\param{wxCommandEvent\&}{ event}}
+\func{virtual wxToolBar*}{OnCreateToolBar}{\param{long}{ style},
+ \param{wxWindowID}{ id}, \param{const wxString\&}{ name}}

 
 

-See \helpref{wxWindow::OnMenuCommand}{wxwindowonmenucommand}.
+Virtual function called when a toolbar is requested by \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.

 
 

-\membersection{wxFrame::OnMenuHighlight}\label{wxframeonmenuhighlight}
+\wxheading{Parameters}

 
 

-\func{void}{OnMenuHighlight}{\param{wxMenuEvent\&}{ event}}
+\docparam{style}{The toolbar style. See \helpref{wxToolBar}{wxtoolbar} for a list
+of valid styles.}

 
 

-See \helpref{wxWindow::OnMenuHighlight}{wxwindowonmenuhighlight}.
+\docparam{id}{The toolbar window identifier. If -1, an identifier will be chosen by
+wxWindows.}

 
 

-\membersection{wxFrame::OnSize}\label{wxframeonsize}
+\docparam{name}{The toolbar window name.}

 
 

-\func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
+\wxheading{Return value}

 
 

-See \helpref{wxWindow::OnSize}{wxwindowonsize}.
+A toolbar object.

 
 

-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).
+\wxheading{Remarks}
+
+An application can override this function to return a different kind of toolbar. The default
+implementation returns an instance of \helpref{wxToolBar}{wxtoolbar}.
+
+\wxheading{See also}
+
+\helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar}.
+
+\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.

 
 \membersection{wxFrame::SetIcon}\label{wxframeseticon}
 
 
 \membersection{wxFrame::SetIcon}\label{wxframeseticon}
 


@@ -329,38 +453,46 @@ 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.
 
 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.
+See also \helpref{wxIcon}{wxicon}.

 
 

-If these icons are not supplied, and {\bf SetIcon} is not called either,
-then the following defaults apply if you have included wx.rc.
+\membersection{wxFrame::SetIcons}\label{wxframeseticons}

 
 

-\begin{verbatim}
-wxDEFAULT_FRAME               ICON std.ico
-wxDEFAULT_MDIPARENTFRAME      ICON mdi.ico
-wxDEFAULT_MDICHILDFRAME       ICON child.ico
-\end{verbatim}
+\func{void}{SetIcons}{\param{const wxIconBundle\& }{icons}}

 
 

-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.
+Sets the icons for this frame.

 
 

-{\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.
+\wxheading{Parameters}

 
 

-See also \helpref{wxIcon}{wxicon}.
+\docparam{icons}{The icons to associate with this frame.}
+
+See also \helpref{wxIconBundle}{wxiconbundle}.
+
+% 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 wxWindows application. Currently they show the same icon.

 
 \membersection{wxFrame::SetMenuBar}\label{wxframesetmenubar}
 
 
 \membersection{wxFrame::SetMenuBar}\label{wxframesetmenubar}
 


@@ -379,18 +511,47 @@ 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).
 
 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}.
 
 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}
 
 \helpref{wxFrame::GetMenuBar}{wxframegetmenubar}, \helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}.
 
 
 \wxheading{See also}
 
 \helpref{wxFrame::GetMenuBar}{wxframegetmenubar}, \helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}.
 

+\membersection{wxFrame::SetShape}\label{wxframesetshape}
+
+\func{bool}{SetShape}{\param{const wxRegion\&}{ region}}
+
+If the platform supports it, sets the shape of the window to that
+depicted by \it{region}.  The system will not display or
+respond to any mouse event for the pixels that lie outside of the
+region.  To reset the window to the normal rectangular shape simply
+call \it{SetShape} again with an empty region.  Returns TRUE if the
+operation is successful.
+
+\membersection{wxFrame::SetStatusBar}\label{wxframesetstatusbar}
+
+\func{void}{SetStatusBar}{\param{wxStatusBar*}{ statusBar}}
+
+Associates a status bar with the frame.
+
+\wxheading{See also}
+
+\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}
 
 \membersection{wxFrame::SetStatusText}\label{wxframesetstatustext}
 

-\func{virtual void}{SetStatusText}{\param{const wxString\& }{ text}, \param{const int}{ number = 0}}
+\func{virtual void}{SetStatusText}{\param{const wxString\& }{ text}, \param{int}{ number = 0}}

 
 Sets the status bar text and redraws the status bar.
 
 
 Sets the status bar text and redraws the status bar.
 


@@ -410,7 +571,7 @@ Use an empty string to clear the status bar.
 
 \membersection{wxFrame::SetStatusWidths}\label{wxframesetstatuswidths}
 
 
 \membersection{wxFrame::SetStatusWidths}\label{wxframesetstatuswidths}
 

-\func{virtual void}{SetStatusWidths}{\param{const int}{ n}, \param{const int *}{widths}}
+\func{virtual void}{SetStatusWidths}{\param{int}{ n}, \param{int *}{widths}}

 
 Sets the widths of the fields in the status bar.
 
 
 Sets the widths of the fields in the status bar.
 


@@ -426,9 +587,25 @@ field must be -1. You should delete this array after calling {\bf SetStatusWidth
 \wxheading{Remarks}
 
 The widths of the variable fields are calculated from the total width of all fields,
 \wxheading{Remarks}
 
 The widths of the variable fields are calculated from the total width of all fields,

-minus the sum of widths of the non-variable fields, divided by the number of 
+minus the sum of widths of the non-variable fields, divided by the number of

 variable fields.
 
 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}
+
+\func{void}{SetToolBar}{\param{wxToolBar*}{ toolBar}}
+
+Associates a toolbar with the frame.
+
+\wxheading{See also}
+
+\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}}
 \membersection{wxFrame::SetTitle}\label{wxframesettitle}
 
 \func{virtual void}{SetTitle}{\param{const wxString\& }{ title}}


@@ -443,3 +620,30 @@ Sets the frame title.
 
 \helpref{wxFrame::GetTitle}{wxframegettitle}
 
 
 \helpref{wxFrame::GetTitle}{wxframegettitle}
 

+\membersection{wxFrame::ShowFullScreen}\label{wxframeshowfullscreen}
+
+\func{bool}{ShowFullScreen}{\param{bool}{ show}, \param{long}{ style = wxFULLSCREEN\_ALL}}
+
+Depending on the value of {\it show} parameter the frame is either shown full
+screen or restored to its normal state. {\it style} is a bit list containing
+some or all of the following values, which indicate what elements of the frame
+to hide in full-screen mode:
+
+\begin{itemize}\itemsep=0pt
+\item wxFULLSCREEN\_NOMENUBAR
+\item wxFULLSCREEN\_NOTOOLBAR
+\item wxFULLSCREEN\_NOSTATUSBAR
+\item wxFULLSCREEN\_NOBORDER
+\item wxFULLSCREEN\_NOCAPTION
+\item wxFULLSCREEN\_ALL (all of the above)
+\end{itemize}
+
+This function has not been tested with MDI frames.
+
+Note that showing a frame full screen also actually
+\helpref{Show()s}{wxwindowshow} if it hadn't been shown yet.
+
+\wxheading{See also}
+
+\helpref{wxFrame::IsFullScreen}{wxframeisfullscreen}
+