Fixes for documentation compilation

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

diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex
index 29c31e7c3b9bbcf7a2c04b3be3ebd3e24d65b36b..950fe6da08d8edad438a76fdb23d7c8bffbef3ab 100644 (file)
--- a/docs/latex/wx/frame.tex
+++ b/docs/latex/wx/frame.tex
@@ -24,7 +24,7 @@ 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\_BOX \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}.}

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


@@ -47,7 +47,11 @@ wxFRAME\_TOOL\_WINDOW or wxFRAME\_NO\_TASKBAR instead}
 caption. When pressed, Windows will go into a context-sensitive help mode and wxWindows 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).
 caption. When pressed, Windows will go into a context-sensitive help mode and wxWindows 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.}
+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
+default)}

 \end{twocollist}
 
 The default frame style is for normal, resizeable frames. To create a frame
 \end{twocollist}
 
 The default frame style is for normal, resizeable frames. To create a frame


@@ -59,7 +63,7 @@ See also \helpref{window styles overview}{windowstyles}.
 
 \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}


@@ -396,29 +400,26 @@ 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}}
 
 \membersection{wxFrame::OnMenuHighlight}\label{wxframeonmenuhighlight}
 
 \func{void}{OnMenuHighlight}{\param{wxMenuEvent\&}{ event}}
 

-See \helpref{wxWindow::OnMenuHighlight}{wxwindowonmenuhighlight}.
+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}}
 
 
 \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).
 
 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::SetIcon}\label{wxframeseticon}
 
 \func{void}{SetIcon}{\param{const wxIcon\& }{icon}}
 \membersection{wxFrame::SetIcon}\label{wxframeseticon}
 
 \func{void}{SetIcon}{\param{const wxIcon\& }{icon}}


@@ -435,6 +436,20 @@ 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.
 

+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
 % VZ: we don't have all this any more (18.08.00) 
 %
 %Under Windows, instead of using {\bf SetIcon}, you can add the


@@ -462,8 +477,6 @@ calling this function.
 %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.
 
 %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}.
-

 \membersection{wxFrame::SetMenuBar}\label{wxframesetmenubar}
 
 \func{void}{SetMenuBar}{\param{wxMenuBar* }{menuBar}}
 \membersection{wxFrame::SetMenuBar}\label{wxframesetmenubar}
 
 \func{void}{SetMenuBar}{\param{wxMenuBar* }{menuBar}}


@@ -594,3 +607,4 @@ This function has not been tested with MDI frames.
 \wxheading{See also}
 
 \helpref{wxFrame::IsFullScreen}{wxframeisfullscreen}
 \wxheading{See also}
 
 \helpref{wxFrame::IsFullScreen}{wxframeisfullscreen}

+