Controls will readjust their size and minsize when SetLabel or SetFont

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

diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex
index daaa50e60e347f3fbcaaa67f6620fa1c24e73f84..89e56d46bca4b614b2b8a54c3d472c869be113d4 100644 (file)
--- a/docs/latex/wx/frame.tex
+++ b/docs/latex/wx/frame.tex
@@ -24,46 +24,67 @@ application windows.
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt

-\twocolitem{\windowstyle{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxRESIZE\_BORDER \pipe wxSYSTEM\_MENU \pipe wxCAPTION}.}
+\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{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{wxICONIZE}}{Display the frame iconized (minimized). Windows only. }
 \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the frame.}
 \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{wxSTAY\_ON\_TOP}}{Stay on top of other windows. Windows only.}
+\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{wxSYSTEM\_MENU}}{Displays a system menu.}

-\twocolitem{\windowstyle{wxSIMPLE\_BORDER}}{Displays no border or decorations. GTK and Windows only.}

 \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{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 a normal frame but if
-this frame has a parent it does not appear in the taskbar under Windows. Note
-that a frame without parent will still appear in the taskbar even with this
-style. Has no effect under other platforms.}
-\twocolitem{\windowstyle{wxFRAME\_FLOAT\_ON\_PARENT}}{Unused any longer, use
-wxFRAME\_TOOL\_WINDOW or wxFRAME\_NO\_TASKBAR instead}
+\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
 \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
+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
 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 minimize nor maximize box by
+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)}
 default)}

+\twocolitem{\windowstyle{wxFRAME\_SHAPED}}{Windows with this style are
+  allowed to have their shape changed with the \helpref{SetShape}{wxframesetshape} method.}

 \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
 \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}.
 
 % 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}
 
 \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}


@@ -96,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
 \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
 
 \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}.}
 
 
 \docparam{style}{The window style. See \helpref{wxFrame}{wxframe}.}
 


@@ -169,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
 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.}
 
 
 \docparam{name}{The status bar window name.}
 


@@ -206,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
 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.}
 
 
 \docparam{name}{The toolbar window name.}
 


@@ -259,6 +280,16 @@ 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::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}
 \membersection{wxFrame::GetTitle}\label{wxframegettitle}
 
 \constfunc{wxString}{GetTitle}{\void}


@@ -284,7 +315,7 @@ Iconizes or restores the frame.
 
 \wxheading{Parameters}
 
 
 \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}
 
 
 \wxheading{See also}
 


@@ -294,7 +325,7 @@ Iconizes or restores the frame.
 
 \func{bool}{IsFullScreen}{\void}
 
 
 \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}
 
 
 \wxheading{See also}
 


@@ -304,13 +335,13 @@ Returns TRUE if the frame is in fullscreen mode.
 
 \constfunc{bool}{IsIconized}{\void}
 
 
 \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}
 
 
 \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}
 
 
 \membersection{wxFrame::Maximize}\label{wxframemaximize}
 


@@ -320,7 +351,7 @@ Maximizes or restores the frame.
 
 \wxheading{Parameters}
 
 
 \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}
 


@@ -330,13 +361,6 @@ This function only works under Windows.
 
 \helpref{wxFrame::Iconize}{wxframeiconize}
 
 
 \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},
 \membersection{wxFrame::OnCreateStatusBar}\label{wxframeoncreatestatusbar}
 
 \func{virtual wxStatusBar*}{OnCreateStatusBar}{\param{int }{number},


@@ -353,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
 of valid styles.}
 
 \docparam{id}{The window identifier. If -1, an identifier will be chosen by

-wxWindows.}
+wxWidgets.}

 
 \docparam{name}{The window name.}
 
 
 \docparam{name}{The window name.}
 


@@ -383,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
 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.}
 
 
 \docparam{name}{The toolbar window name.}
 


@@ -400,28 +424,18 @@ implementation returns an instance of \helpref{wxToolBar}{wxtoolbar}.
 
 \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \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::OnMenuHighlight}\label{wxframeonmenuhighlight}
-
-\func{void}{OnMenuHighlight}{\param{wxMenuEvent\&}{ event}}
-
-See \helpref{wxWindow::OnMenuHighlight}{wxwindowonmenuhighlight}.
+\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.

 
 

-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}
 
 
 \membersection{wxFrame::SetIcon}\label{wxframeseticon}
 


@@ -439,7 +453,21 @@ 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.
 

-% VZ: we don't have all this any more (18.08.00) 
+See also \helpref{wxIcon}{wxicon}.
+
+\membersection{wxFrame::SetIcons}\label{wxframeseticons}
+
+\func{void}{SetIcons}{\param{const wxIconBundle\& }{icons}}
+
+Sets the icons for this frame.
+
+\wxheading{Parameters}
+
+\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:
 %
 %Under Windows, instead of using {\bf SetIcon}, you can add the
 %following lines to your MS Windows resource file:


@@ -464,9 +492,7 @@ calling this function.
 %\end{verbatim}
 %
 %You can replace std.ico, mdi.ico and child.ico with your own defaults
 %\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.
-
-See also \helpref{wxIcon}{wxicon}.
+%for all your wxWidgets application. Currently they show the same icon.

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


@@ -485,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).
 
 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}}
 \membersection{wxFrame::SetStatusBar}\label{wxframesetstatusbar}
 
 \func{void}{SetStatusBar}{\param{wxStatusBar*}{ statusBar}}


@@ -505,6 +542,13 @@ Associates a status bar with the frame.
 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar},\rtfsp
 \helpref{wxFrame::GetStatusBar}{wxframegetstatusbar}
 
 \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}}
 \membersection{wxFrame::SetStatusText}\label{wxframesetstatustext}
 
 \func{virtual void}{SetStatusText}{\param{const wxString\& }{ text}, \param{int}{ number = 0}}


@@ -580,9 +624,10 @@ Sets the frame title.
 
 \func{bool}{ShowFullScreen}{\param{bool}{ show}, \param{long}{ style = wxFULLSCREEN\_ALL}}
 
 
 \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
-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:
+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
 
 \begin{itemize}\itemsep=0pt
 \item wxFULLSCREEN\_NOMENUBAR


@@ -595,6 +640,9 @@ indicate what elements of the frame to hide in full-screen mode:
 
 This function has not been tested with MDI frames.
 
 
 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}
 \wxheading{See also}
 
 \helpref{wxFrame::IsFullScreen}{wxframeisfullscreen}