X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dbdb39b2d0b8c3359eab1693fd1fc786499f62d7..fe161a2685012cf90bb5bfe95f2260aee71d8ad7:/docs/latex/wx/frame.tex diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex index ebe13b0449..89e56d46bc 100644 --- a/docs/latex/wx/frame.tex +++ b/docs/latex/wx/frame.tex @@ -1,12 +1,14 @@ \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. +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} @@ -22,28 +24,67 @@ the remaining size available to application windows. \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{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 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}{wxframesetshape} method.} \end{twocollist} -See also \helpref{window styles overview}{windowstyles}. Currently the GTK port of wxWindows -ignores all the window styles listed above as there is no standard way (yet) to inform the -window manager about such options. Therefore, the only relevant window style flag which -the GTK port recognizes is \windowstyle{wxSIMPLE\_BORDER} which brings up a frame without -any window decorations. This can be used for a splash screen or specialized tooltip etc. +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} @@ -76,10 +117,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}.} @@ -149,7 +190,7 @@ 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.} @@ -186,7 +227,7 @@ 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.} @@ -212,6 +253,13 @@ reflect the available space for application windows. \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} @@ -224,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). @@ -232,16 +280,25 @@ Returns a pointer to the status bar currently associated with the frame (if any) \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar} +\membersection{wxFrame::GetStatusBarPane}\label{wxframegetstatusbarpane} + +\func{int}{GetStatusBarPane}{\void} + +Returns the status bar pane used to display menu and toolbar help. + +\wxheading{See also} + +\helpref{wxFrame::SetStatusBarPane}{wxframesetstatusbarpane} + \membersection{wxFrame::GetTitle}\label{wxframegettitle} -\func{wxString\&}{GetTitle}{\void} +\constfunc{wxString}{GetTitle}{\void} -Gets a temporary pointer to the frame title. See -\helpref{wxFrame::SetTitle}{wxframesettitle}. +Gets a string containing the frame title. See \helpref{wxFrame::SetTitle}{wxframesettitle}. \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). @@ -252,39 +309,49 @@ Returns a pointer to the toolbar currently associated with the frame (if any). \membersection{wxFrame::Iconize}\label{wxframeiconize} -\func{void}{Iconize}{\param{const bool}{ iconize}} +\func{void}{Iconize}{\param{bool}{ iconize}} Iconizes or restores the frame. \wxheading{Parameters} -\docparam{izonize}{If TRUE, iconizes the frame; if FALSE, shows and restores it.} +\docparam{iconize}{If true, iconizes the frame; if false, shows and restores it.} \wxheading{See also} \helpref{wxFrame::IsIconized}{wxframeisiconized}, \helpref{wxFrame::Maximize}{wxframemaximize}. +\membersection{wxFrame::IsFullScreen}\label{wxframeisfullscreen} + +\func{bool}{IsFullScreen}{\void} + +Returns true if the frame is in fullscreen mode. + +\wxheading{See also} + +\helpref{wxFrame::ShowFullScreen}{wxframeshowfullscreen} + \membersection{wxFrame::IsIconized}\label{wxframeisiconized} \constfunc{bool}{IsIconized}{\void} -Returns TRUE if the frame is iconized. +Returns true if the frame is iconized. \membersection{wxFrame::IsMaximized}\label{wxframeismaximized} \constfunc{bool}{IsMaximized}{\void} -Returns TRUE if the frame is maximized. +Returns true if the frame is maximized. \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} -\docparam{maximize}{If TRUE, maximizes the frame, otherwise it restores it}. +\docparam{maximize}{If true, maximizes the frame, otherwise it restores it.} \wxheading{Remarks} @@ -294,13 +361,6 @@ This function only works under Windows. \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}, @@ -317,7 +377,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.} @@ -347,7 +407,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.} @@ -364,28 +424,18 @@ 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::SendSizeEvent}\label{wxframesendsizeevent} -\membersection{wxFrame::OnMenuHighlight}\label{wxframeonmenuhighlight} +\func{void}{SendSizeEvent}{\void} -\func{void}{OnMenuHighlight}{\param{wxMenuEvent\&}{ event}} +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. -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). +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} @@ -403,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. -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 wxWidgets application. Currently they show the same icon. \membersection{wxFrame::SetMenuBar}\label{wxframesetmenubar} @@ -453,15 +511,26 @@ 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} \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}} @@ -473,6 +542,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}} @@ -511,9 +587,14 @@ 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, -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. +\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}} @@ -539,3 +620,30 @@ Sets the frame title. \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} +