X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9dfef5ac200277eb1943cde5c1beafa2f392ab88..7b4c31495268b3452019c67e52ff8ff86c03e36c:/docs/latex/wx/frame.tex

diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex
index e7cb84094b..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 \& \~ (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 \& \~ (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
@@ -262,6 +278,16 @@ 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}
 
 \constfunc{wxString}{GetTitle}{\void}
@@ -287,7 +313,7 @@ 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}
 
@@ -297,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}
 
@@ -307,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}
 
@@ -323,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}
 
@@ -333,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},
@@ -403,25 +422,18 @@ 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::SendSizeEvent}\label{wxframesendsizeevent}
 
-\membersection{wxFrame::OnSize}\label{wxframeonsize}
+\func{void}{SendSizeEvent}{\void}
 
-\func{void}{OnSize}{\param{wxSizeEvent\& }{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.
 
-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}.
+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}
 
@@ -517,6 +529,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}}
@@ -592,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:
 
@@ -611,39 +630,3 @@ This function has not been tested with MDI frames.
 
 \helpref{wxFrame::IsFullScreen}{wxframeisfullscreen}
 
-\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::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::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::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}
-
-
-
