X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2b5f62a0b2db198609b45dec622a018dae37008e..7b4c31495268b3452019c67e52ff8ff86c03e36c:/docs/latex/wx/frame.tex diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex index 1ee544180c..306e3a81fc 100644 --- a/docs/latex/wx/frame.tex +++ b/docs/latex/wx/frame.tex @@ -52,18 +52,34 @@ a wxEVT\_HELP event if the user clicked on an application window. {\it Note} tha 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 \& \verb$~$ (wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the +{\tt wxDEFAULT\_FRAME\_STYLE \& (wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the frames having this style (the dialogs don't have minimize nor maximize box by default)} \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 \& \verb$~$ (wxRESIZE\_BORDER \pipe wxRESIZE\_BOX \pipe wxMAXIMIZE\_BOX)}. +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{wxCloseEvent}{wxcloseevent} handler for the @@ -297,7 +313,7 @@ Iconizes or restores the frame. \wxheading{Parameters} -\docparam{iconize}{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} @@ -307,7 +323,7 @@ Iconizes or restores the frame. \func{bool}{IsFullScreen}{\void} -Returns TRUE if the frame is in fullscreen mode. +Returns true if the frame is in fullscreen mode. \wxheading{See also} @@ -317,13 +333,13 @@ Returns TRUE if the frame is in fullscreen mode. \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} @@ -333,7 +349,7 @@ 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} @@ -343,13 +359,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}, @@ -413,26 +422,6 @@ implementation returns an instance of \helpref{wxToolBar}{wxtoolbar}. \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar}. -\membersection{wxFrame::OnMenuHighlight}\label{wxframeonmenuhighlight} - -\func{void}{OnMenuHighlight}{\param{wxMenuEvent\&}{ event}} - -The default implementation displays an appropriate help string -in the status bar, if there is one. - -See \helpref{wxMenuEvent}{wxmenuevent}. - -\membersection{wxFrame::OnSize}\label{wxframeonsize} - -\func{void}{OnSize}{\param{wxSizeEvent\& }{event}} - -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). - -See \helpref{wxSizeEvent}{wxsizeevent}. - \membersection{wxFrame::SendSizeEvent}\label{wxframesendsizeevent} \func{void}{SendSizeEvent}{\void} @@ -622,7 +611,7 @@ Sets the frame title. \func{bool}{ShowFullScreen}{\param{bool}{ show}, \param{long}{ style = wxFULLSCREEN\_ALL}} -Passing TRUE to {\it shows} shows the frame full-screen, and passing FALSE restores the frame +Passing true to {\it shows} shows the frame full-screen, and passing false restores the frame again. {\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: