1 \section{\class{wxFrame
}}\label{wxframe
}
3 A frame is a window whose size and position can (usually) be changed by the
4 user. It usually has thick borders and a title bar, and can optionally contain
5 a menu bar, toolbar and status bar. A frame can contain any window that is not
8 A frame that has a status bar and toolbar created via the
9 CreateStatusBar/CreateToolBar functions manages these windows, and adjusts the
10 value returned by GetClientSize to reflect the remaining size available to
13 \wxheading{Derived from
}
15 \helpref{wxWindow
}{wxwindow
}\\
16 \helpref{wxEvtHandler
}{wxevthandler
}\\
17 \helpref{wxObject
}{wxobject
}
19 \wxheading{Include files
}
23 \wxheading{Window styles
}
26 \begin{twocollist
}\itemsep=
0pt
27 \twocolitem{\windowstyle{wxDEFAULT
\_FRAME\_STYLE}}{Defined as
{\bf wxMINIMIZE
\_BOX \pipe wxMAXIMIZE
\_BOX \pipe wxRESIZE
\_BORDER \pipe wxSYSTEM
\_MENU \pipe wxCAPTION
\pipe wxCLOSE
\_BOX}.
}
28 \twocolitem{\windowstyle{wxICONIZE
}}{Display the frame iconized (minimized). Windows only.
}
29 \twocolitem{\windowstyle{wxCAPTION
}}{Puts a caption on the frame.
}
30 \twocolitem{\windowstyle{wxMINIMIZE
}}{Identical to
{\bf wxICONIZE
}. Windows only.
}
31 \twocolitem{\windowstyle{wxMINIMIZE
\_BOX}}{Displays a minimize box on the frame.
}
32 \twocolitem{\windowstyle{wxMAXIMIZE
}}{Displays the frame maximized. Windows only.
}
33 \twocolitem{\windowstyle{wxMAXIMIZE
\_BOX}}{Displays a maximize box on the frame.
}
34 \twocolitem{\windowstyle{wxCLOSE
\_BOX}}{Displays a close box on the frame.
}
35 \twocolitem{\windowstyle{wxSTAY
\_ON\_TOP}}{Stay on top of all other windows,
36 see also wxFRAME
\_FLOAT\_ON\_PARENT. Windows only.
}
37 \twocolitem{\windowstyle{wxSYSTEM
\_MENU}}{Displays a system menu.
}
38 \twocolitem{\windowstyle{wxSIMPLE
\_BORDER}}{Displays no border or decorations. GTK and Windows only.
}
39 \twocolitem{\windowstyle{wxRESIZE
\_BORDER}}{Displays a resizeable border around the window.
}
40 \twocolitem{\windowstyle{wxFRAME
\_TOOL\_WINDOW}}{Causes a frame with a small
41 titlebar to be created; the frame does not appear in the taskbar under Windows.
}
42 \twocolitem{\windowstyle{wxFRAME
\_NO\_TASKBAR}}{Creates an otherwise normal
43 frame but it does not appear in the taskbar under Windows (note that it will
44 minimize to the desktop window which may seem strange to the users and thus it
45 might be better to use this style only without wxMINIMIZE
\_BOX style).
46 Has no effect under other platforms.
}
47 \twocolitem{\windowstyle{wxFRAME
\_FLOAT\_ON\_PARENT}}{The frame will always be
48 on top of its parent (unlike wxSTAY
\_ON\_TOP). A frame created with this style
49 must have a non-NULL parent.
}
50 \twocolitem{\windowstyle{wxFRAME
\_EX\_CONTEXTHELP}}{Under Windows, puts a query button on the
51 caption. When pressed, Windows will go into a context-sensitive help mode and wxWindows will send
52 a wxEVT
\_HELP event if the user clicked on an application window.
{\it Note
} that this is an extended
53 style and must be set by calling
\helpref{SetExtraStyle
}{wxwindowsetextrastyle
} before Create is called (two-step construction).
54 You cannot use this style together with wxMAXIMIZE
\_BOX or wxMINIMIZE
\_BOX, so
56 {\tt wxDEFAULT
\_FRAME\_STYLE \& (wxMINIMIZE
\_BOX | wxMAXIMIZE
\_BOX)
} for the
57 frames having this style (the dialogs don't have minimize nor maximize box by
61 The default frame style is for normal, resizeable frames. To create a frame
62 which can not be resized by user, you may use the following combination of
63 styles:
{\tt wxDEFAULT
\_FRAME\_STYLE \& (wxRESIZE
\_BORDER \pipe wxRESIZE
\_BOX \pipe wxMAXIMIZE
\_BOX)
}.
64 % Note: the space after the tilde is necessary or Tex2RTF complains.
66 See also
\helpref{window styles overview
}{windowstyles
}.
68 \wxheading{Default event processing
}
70 wxFrame processes the following events:
72 \begin{twocollist
}\itemsep=
0pt
73 \twocolitem{\helpref{wxEVT
\_SIZE}{wxsizeevent
}}{If the frame has exactly one
74 child window, not counting the status and toolbar, this child is resized to
75 take the entire frame client area. If two or more windows are present, they
76 should be laid out explicitly either by manually handling wxEVT
\_SIZE or using
77 \helpref{sizers
}{sizeroverview
}}
79 \twocolitem{\helpref{wxEVT
\_MENU\_HIGHLIGHT}{wxmenuevent
}}{The default
80 implementation displays the
\helpref{help string
}{wxmenuitemgethelp
} associated
81 with the selected item in the first pane of the status bar, if there is one.
}
86 An application should normally define an
\helpref{wxCloseEvent
}{wxcloseevent
} handler for the
87 frame to respond to system close events, for example so that related data and subwindows can be cleaned up.
91 \helpref{wxMDIParentFrame
}{wxmdiparentframe
},
\helpref{wxMDIChildFrame
}{wxmdichildframe
},
\rtfsp
92 \helpref{wxMiniFrame
}{wxminiframe
},
\helpref{wxDialog
}{wxdialog
}
94 \latexignore{\rtfignore{\wxheading{Members
}}}
96 \membersection{wxFrame::wxFrame
}\label{wxframeconstr
}
98 \func{}{wxFrame
}{\void}
102 \func{}{wxFrame
}{\param{wxWindow*
}{parent
},
\param{wxWindowID
}{id
},
\rtfsp
103 \param{const wxString\&
}{title
},
\param{const wxPoint\&
}{ pos = wxDefaultPosition
},
\rtfsp
104 \param{const wxSize\&
}{ size = wxDefaultSize
},
\param{long
}{ style = wxDEFAULT
\_FRAME\_STYLE},
\rtfsp
105 \param{const wxString\&
}{name = ``frame"
}}
107 Constructor, creating the window.
109 \wxheading{Parameters
}
111 \docparam{parent
}{The window parent. This may be NULL. If it is non-NULL, the frame will
112 always be displayed on top of the parent window on Windows.
}
114 \docparam{id
}{The window identifier. It may take a value of -
1 to indicate a default value.
}
116 \docparam{title
}{The caption to be displayed on the frame's title bar.
}
118 \docparam{pos
}{The window position. A value of (-
1, -
1) indicates a default position, chosen by
119 either the windowing system or wxWindows, depending on platform.
}
121 \docparam{size
}{The window size. A value of (-
1, -
1) indicates a default size, chosen by
122 either the windowing system or wxWindows, depending on platform.
}
124 \docparam{style
}{The window style. See
\helpref{wxFrame
}{wxframe
}.
}
126 \docparam{name
}{The name of the window. This parameter is used to associate a name with the item,
127 allowing the application user to set Motif resource values for
132 For Motif, MWM (the Motif Window Manager) should be running for any window styles to work
133 (otherwise all styles take effect).
137 \helpref{wxFrame::Create
}{wxframecreate
}
139 \membersection{wxFrame::
\destruct{wxFrame
}}
141 \func{void
}{\destruct{wxFrame
}}{\void}
143 Destructor. Destroys all child windows and menu bar if present.
145 \membersection{wxFrame::Centre
}\label{wxframecentre
}
147 \func{void
}{Centre
}{\param{int
}{ direction = wxBOTH
}}
149 Centres the frame on the display.
151 \wxheading{Parameters
}
153 \docparam{direction
}{The parameter may be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
} or
{\tt wxBOTH
}.
}
155 \membersection{wxFrame::Command
}\label{wxframecommand
}
157 \func{void
}{Command
}{\param{int
}{id
}}
159 Simulate a menu command.
161 \wxheading{Parameters
}
163 \docparam{id
}{The identifier for a menu item.
}
165 \membersection{wxFrame::Create
}\label{wxframecreate
}
167 \func{bool
}{Create
}{\param{wxWindow*
}{parent
},
\param{wxWindowID
}{id
},
\rtfsp
168 \param{const wxString\&
}{title
},
\param{const wxPoint\&
}{ pos = wxDefaultPosition
},
\rtfsp
169 \param{const wxSize\&
}{ size = wxDefaultSize
},
\param{long
}{ style = wxDEFAULT
\_FRAME\_STYLE},
\rtfsp
170 \param{const wxString\&
}{name = ``frame"
}}
172 Used in two-step frame construction. See
\helpref{wxFrame::wxFrame
}{wxframeconstr
}\rtfsp
175 \membersection{wxFrame::CreateStatusBar
}\label{wxframecreatestatusbar
}
177 \func{virtual wxStatusBar*
}{CreateStatusBar
}{\param{int
}{ number =
1},
178 \param{long
}{ style =
0},
179 \param{wxWindowID
}{ id = -
1},
\param{const wxString\&
}{ name = "statusBar"
}}
181 Creates a status bar at the bottom of the frame.
183 \wxheading{Parameters
}
185 \docparam{number
}{The number of fields to create. Specify a
186 value greater than
1 to create a multi-field status bar.
}
188 \docparam{style
}{The status bar style. See
\helpref{wxStatusBar
}{wxstatusbar
} for a list
191 \docparam{id
}{The status bar window identifier. If -
1, an identifier will be chosen by
194 \docparam{name
}{The status bar window name.
}
196 \wxheading{Return value
}
198 A pointer to the the status bar if it was created successfully, NULL otherwise.
202 The width of the status bar is the whole width of the frame (adjusted automatically when
203 resizing), and the height and text size are chosen by the host windowing system.
205 By default, the status bar is an instance of wxStatusBar. To use a different class,
206 override
\helpref{wxFrame::OnCreateStatusBar
}{wxframeoncreatestatusbar
}.
208 Note that you can put controls and other windows on the status bar if you wish.
212 \helpref{wxFrame::SetStatusText
}{wxframesetstatustext
},
\rtfsp
213 \helpref{wxFrame::OnCreateStatusBar
}{wxframeoncreatestatusbar
},
\rtfsp
214 \helpref{wxFrame::GetStatusBar
}{wxframegetstatusbar
}
216 \membersection{wxFrame::CreateToolBar
}\label{wxframecreatetoolbar
}
218 \func{virtual wxToolBar*
}{CreateToolBar
}{\param{long
}{ style = wxNO
\_BORDER \pipe wxTB
\_HORIZONTAL},
219 \param{wxWindowID
}{ id = -
1},
\param{const wxString\&
}{ name = "toolBar"
}}
221 Creates a toolbar at the top or left of the frame.
223 \wxheading{Parameters
}
225 \docparam{style
}{The toolbar style. See
\helpref{wxToolBar
}{wxtoolbar
} for a list
228 \docparam{id
}{The toolbar window identifier. If -
1, an identifier will be chosen by
231 \docparam{name
}{The toolbar window name.
}
233 \wxheading{Return value
}
235 A pointer to the the toolbar if it was created successfully, NULL otherwise.
239 By default, the toolbar is an instance of wxToolBar (which is defined to be
240 a suitable toolbar class on each platform, such as wxToolBar95). To use a different class,
241 override
\helpref{wxFrame::OnCreateToolBar
}{wxframeoncreatetoolbar
}.
243 When a toolbar has been created with this function, or made known to the frame
244 with
\helpref{wxFrame::SetToolBar
}{wxframesettoolbar
}, the frame will manage the toolbar
245 position and adjust the return value from
\helpref{wxWindow::GetClientSize
}{wxwindowgetclientsize
} to
246 reflect the available space for application windows.
250 \helpref{wxFrame::CreateStatusBar
}{wxframecreatestatusbar
},
\rtfsp
251 \helpref{wxFrame::OnCreateToolBar
}{wxframeoncreatetoolbar
},
\rtfsp
252 \helpref{wxFrame::SetToolBar
}{wxframesettoolbar
},
\rtfsp
253 \helpref{wxFrame::GetToolBar
}{wxframegettoolbar
}
255 \membersection{wxFrame::GetClientAreaOrigin
}\label{wxframegetclientareaorigin
}
257 \constfunc{wxPoint
}{GetClientAreaOrigin
}{\void}
259 Returns the origin of the frame client area (in client coordinates). It may be
260 different from (
0,
0) if the frame has a toolbar.
262 \membersection{wxFrame::GetMenuBar
}\label{wxframegetmenubar
}
264 \constfunc{wxMenuBar*
}{GetMenuBar
}{\void}
266 Returns a pointer to the menubar currently associated with the frame (if any).
270 \helpref{wxFrame::SetMenuBar
}{wxframesetmenubar
},
\helpref{wxMenuBar
}{wxmenubar
},
\helpref{wxMenu
}{wxmenu
}
272 \membersection{wxFrame::GetStatusBar
}\label{wxframegetstatusbar
}
274 \constfunc{wxStatusBar*
}{GetStatusBar
}{\void}
276 Returns a pointer to the status bar currently associated with the frame (if any).
280 \helpref{wxFrame::CreateStatusBar
}{wxframecreatestatusbar
},
\helpref{wxStatusBar
}{wxstatusbar
}
282 \membersection{wxFrame::GetStatusBarPane
}\label{wxframegetstatusbarpane
}
284 \func{int
}{GetStatusBarPane
}{\void}
286 Returns the status bar pane used to display menu and toolbar help.
290 \helpref{wxFrame::SetStatusBarPane
}{wxframesetstatusbarpane
}
292 \membersection{wxFrame::GetTitle
}\label{wxframegettitle
}
294 \constfunc{wxString
}{GetTitle
}{\void}
296 Gets a string containing the frame title. See
\helpref{wxFrame::SetTitle
}{wxframesettitle
}.
298 \membersection{wxFrame::GetToolBar
}\label{wxframegettoolbar
}
300 \constfunc{wxToolBar*
}{GetToolBar
}{\void}
302 Returns a pointer to the toolbar currently associated with the frame (if any).
306 \helpref{wxFrame::CreateToolBar
}{wxframecreatetoolbar
},
\helpref{wxToolBar
}{wxtoolbar
},
\rtfsp
307 \helpref{wxFrame::SetToolBar
}{wxframesettoolbar
}
309 \membersection{wxFrame::Iconize
}\label{wxframeiconize
}
311 \func{void
}{Iconize
}{\param{bool
}{ iconize
}}
313 Iconizes or restores the frame.
315 \wxheading{Parameters
}
317 \docparam{iconize
}{If true, iconizes the frame; if false, shows and restores it.
}
321 \helpref{wxFrame::IsIconized
}{wxframeisiconized
},
\helpref{wxFrame::Maximize
}{wxframemaximize
}.
323 \membersection{wxFrame::IsFullScreen
}\label{wxframeisfullscreen
}
325 \func{bool
}{IsFullScreen
}{\void}
327 Returns true if the frame is in fullscreen mode.
331 \helpref{wxFrame::ShowFullScreen
}{wxframeshowfullscreen
}
333 \membersection{wxFrame::IsIconized
}\label{wxframeisiconized
}
335 \constfunc{bool
}{IsIconized
}{\void}
337 Returns true if the frame is iconized.
339 \membersection{wxFrame::IsMaximized
}\label{wxframeismaximized
}
341 \constfunc{bool
}{IsMaximized
}{\void}
343 Returns true if the frame is maximized.
345 \membersection{wxFrame::Maximize
}\label{wxframemaximize
}
347 \func{void
}{Maximize
}{\param{bool
}{maximize
}}
349 Maximizes or restores the frame.
351 \wxheading{Parameters
}
353 \docparam{maximize
}{If true, maximizes the frame, otherwise it restores it.
}
357 This function only works under Windows.
361 \helpref{wxFrame::Iconize
}{wxframeiconize
}
363 \membersection{wxFrame::OnCreateStatusBar
}\label{wxframeoncreatestatusbar
}
365 \func{virtual wxStatusBar*
}{OnCreateStatusBar
}{\param{int
}{number
},
366 \param{long
}{ style
},
367 \param{wxWindowID
}{ id
},
\param{const wxString\&
}{ name
}}
369 Virtual function called when a status bar is requested by
\helpref{wxFrame::CreateStatusBar
}{wxframecreatestatusbar
}.
371 \wxheading{Parameters
}
373 \docparam{number
}{The number of fields to create.
}
375 \docparam{style
}{The window style. See
\helpref{wxStatusBar
}{wxstatusbar
} for a list
378 \docparam{id
}{The window identifier. If -
1, an identifier will be chosen by
381 \docparam{name
}{The window name.
}
383 \wxheading{Return value
}
389 An application can override this function to return a different kind of status bar. The default
390 implementation returns an instance of
\helpref{wxStatusBar
}{wxstatusbar
}.
394 \helpref{wxFrame::CreateStatusBar
}{wxframecreatestatusbar
},
\helpref{wxStatusBar
}{wxstatusbar
}.
396 \membersection{wxFrame::OnCreateToolBar
}\label{wxframeoncreatetoolbar
}
398 \func{virtual wxToolBar*
}{OnCreateToolBar
}{\param{long
}{ style
},
399 \param{wxWindowID
}{ id
},
\param{const wxString\&
}{ name
}}
401 Virtual function called when a toolbar is requested by
\helpref{wxFrame::CreateToolBar
}{wxframecreatetoolbar
}.
403 \wxheading{Parameters
}
405 \docparam{style
}{The toolbar style. See
\helpref{wxToolBar
}{wxtoolbar
} for a list
408 \docparam{id
}{The toolbar window identifier. If -
1, an identifier will be chosen by
411 \docparam{name
}{The toolbar window name.
}
413 \wxheading{Return value
}
419 An application can override this function to return a different kind of toolbar. The default
420 implementation returns an instance of
\helpref{wxToolBar
}{wxtoolbar
}.
424 \helpref{wxFrame::CreateToolBar
}{wxframecreatetoolbar
},
\helpref{wxToolBar
}{wxtoolbar
}.
426 \membersection{wxFrame::SendSizeEvent
}\label{wxframesendsizeevent
}
428 \func{void
}{SendSizeEvent
}{\void}
430 This function sends a dummy
\helpref{size event
}{wxsizeevent
} to the frame
431 forcing it to reevaluate its children positions. It is sometimes useful to call
432 this function after adding or deleting a children after the frame creation or
433 if a child size changes.
435 Note that if the frame is using either sizers or constraints for the children
436 layout, it is enough to call
\helpref{Layout()
}{wxwindowlayout
} directly and
437 this function should not be used in this case.
439 \membersection{wxFrame::SetIcon
}\label{wxframeseticon
}
441 \func{void
}{SetIcon
}{\param{const wxIcon\&
}{icon
}}
443 Sets the icon for this frame.
445 \wxheading{Parameters
}
447 \docparam{icon
}{The icon to associate with this frame.
}
451 The frame takes a `copy' of
{\it icon
}, but since it uses reference
452 counting, the copy is very quick. It is safe to delete
{\it icon
} after
453 calling this function.
455 See also
\helpref{wxIcon
}{wxicon
}.
457 \membersection{wxFrame::SetIcons
}\label{wxframeseticons
}
459 \func{void
}{SetIcons
}{\param{const wxIconBundle\&
}{icons
}}
461 Sets the icons for this frame.
463 \wxheading{Parameters
}
465 \docparam{icons
}{The icons to associate with this frame.
}
467 See also
\helpref{wxIconBundle
}{wxiconbundle
}.
469 % VZ: we don't have all this any more (18.08.00)
471 %Under Windows, instead of using {\bf SetIcon}, you can add the
472 %following lines to your MS Windows resource file:
475 %wxSTD_MDIPARENTFRAME ICON icon1.ico
476 %wxSTD_MDICHILDFRAME ICON icon2.ico
477 %wxSTD_FRAME ICON icon3.ico
480 %where icon1.ico will be used for the MDI parent frame, icon2.ico
481 %will be used for MDI child frames, and icon3.ico will be used for
484 %If these icons are not supplied, and {\bf SetIcon} is not called either,
485 %then the following defaults apply if you have included wx.rc.
488 %wxDEFAULT_FRAME ICON std.ico
489 %wxDEFAULT_MDIPARENTFRAME ICON mdi.ico
490 %wxDEFAULT_MDICHILDFRAME ICON child.ico
493 %You can replace std.ico, mdi.ico and child.ico with your own defaults
494 %for all your wxWindows application. Currently they show the same icon.
496 \membersection{wxFrame::SetMenuBar
}\label{wxframesetmenubar
}
498 \func{void
}{SetMenuBar
}{\param{wxMenuBar*
}{menuBar
}}
500 Tells the frame to show the given menu bar.
502 \wxheading{Parameters
}
504 \docparam{menuBar
}{The menu bar to associate with the frame.
}
508 If the frame is destroyed, the
509 menu bar and its menus will be destroyed also, so do not delete the menu
510 bar explicitly (except by resetting the frame's menu bar to another
513 Under Windows, a call to
\helpref{wxFrame::OnSize
}{wxframeonsize
} is generated, so be sure to initialize
514 data members properly before calling
{\bf SetMenuBar
}.
516 Note that it is not possible to call this function twice for the same frame object.
520 \helpref{wxFrame::GetMenuBar
}{wxframegetmenubar
},
\helpref{wxMenuBar
}{wxmenubar
},
\helpref{wxMenu
}{wxmenu
}.
522 \membersection{wxFrame::SetStatusBar
}\label{wxframesetstatusbar
}
524 \func{void
}{SetStatusBar
}{\param{wxStatusBar*
}{ statusBar
}}
526 Associates a status bar with the frame.
530 \helpref{wxFrame::CreateStatusBar
}{wxframecreatestatusbar
},
\helpref{wxStatusBar
}{wxstatusbar
},
\rtfsp
531 \helpref{wxFrame::GetStatusBar
}{wxframegetstatusbar
}
533 \membersection{wxFrame::SetStatusBarPane
}\label{wxframesetstatusbarpane
}
535 \func{void
}{SetStatusBarPane
}{\param{int
}{ n
}}
537 Set the status bar pane used to display menu and toolbar help.
538 Using -
1 disables help display.
540 \membersection{wxFrame::SetStatusText
}\label{wxframesetstatustext
}
542 \func{virtual void
}{SetStatusText
}{\param{const wxString\&
}{ text
},
\param{int
}{ number =
0}}
544 Sets the status bar text and redraws the status bar.
546 \wxheading{Parameters
}
548 \docparam{text
}{The text for the status field.
}
550 \docparam{number
}{The status field (starting from zero).
}
554 Use an empty string to clear the status bar.
558 \helpref{wxFrame::CreateStatusBar
}{wxframecreatestatusbar
},
\helpref{wxStatusBar
}{wxstatusbar
}
560 \membersection{wxFrame::SetStatusWidths
}\label{wxframesetstatuswidths
}
562 \func{virtual void
}{SetStatusWidths
}{\param{int
}{ n
},
\param{int *
}{widths
}}
564 Sets the widths of the fields in the status bar.
566 \wxheading{Parameters
}
568 \wxheading{n
}{The number of fields in the status bar. It must be the
569 same used in
\helpref{CreateStatusBar
}{wxframecreatestatusbar
}.
}
571 \docparam{widths
}{Must contain an array of
{\it n
} integers, each of which is a status field width
572 in pixels. A value of -
1 indicates that the field is variable width; at least one
573 field must be -
1. You should delete this array after calling
{\bf SetStatusWidths
}.
}
577 The widths of the variable fields are calculated from the total width of all fields,
578 minus the sum of widths of the non-variable fields, divided by the number of
581 \pythonnote{Only a single parameter is required, a Python list of
584 \perlnote{In wxPerl this method takes the field widths as parameters.
}
586 \membersection{wxFrame::SetToolBar
}\label{wxframesettoolbar
}
588 \func{void
}{SetToolBar
}{\param{wxToolBar*
}{ toolBar
}}
590 Associates a toolbar with the frame.
594 \helpref{wxFrame::CreateToolBar
}{wxframecreatetoolbar
},
\helpref{wxToolBar
}{wxtoolbar
},
\rtfsp
595 \helpref{wxFrame::GetToolBar
}{wxframegettoolbar
}
597 \membersection{wxFrame::SetTitle
}\label{wxframesettitle
}
599 \func{virtual void
}{SetTitle
}{\param{const wxString\&
}{ title
}}
601 Sets the frame title.
603 \wxheading{Parameters
}
605 \docparam{title
}{The frame title.
}
609 \helpref{wxFrame::GetTitle
}{wxframegettitle
}
611 \membersection{wxFrame::ShowFullScreen
}\label{wxframeshowfullscreen
}
613 \func{bool
}{ShowFullScreen
}{\param{bool
}{ show
},
\param{long
}{ style = wxFULLSCREEN
\_ALL}}
615 Passing true to
{\it shows
} shows the frame full-screen, and passing false restores the frame
616 again.
{\it style
} is a bit list containing some or all of the following values, which
617 indicate what elements of the frame to hide in full-screen mode:
619 \begin{itemize
}\itemsep=
0pt
620 \item wxFULLSCREEN
\_NOMENUBAR
621 \item wxFULLSCREEN
\_NOTOOLBAR
622 \item wxFULLSCREEN
\_NOSTATUSBAR
623 \item wxFULLSCREEN
\_NOBORDER
624 \item wxFULLSCREEN
\_NOCAPTION
625 \item wxFULLSCREEN
\_ALL (all of the above)
628 This function has not been tested with MDI frames.
632 \helpref{wxFrame::IsFullScreen
}{wxframeisfullscreen
}