added and documented wxDEFINE_SCOPED_PTR_TYPE; improved docs a bit

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

diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex
index 34823f2d60eeaaf7b99942af2c2f0b1774a605ba..c42b8db335fd32ab76293c11db9acad1addd7ccf 100644 (file)
--- a/docs/latex/wx/frame.tex
+++ b/docs/latex/wx/frame.tex
@@ -52,10 +52,12 @@ caption. When pressed, Windows will go into a context-sensitive help mode and wx
 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 
+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)}
+\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
@@ -73,7 +75,7 @@ wxFrame processes the following events:
 \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 
+should be laid out explicitly either by manually handling wxEVT\_SIZE or using
 \helpref{sizers}{sizeroverview}}
 
 \twocolitem{\helpref{wxEVT\_MENU\_HIGHLIGHT}{wxmenuevent}}{The default
@@ -466,7 +468,7 @@ Sets the icons for this frame.
 
 See also \helpref{wxIconBundle}{wxiconbundle}.
 
-% VZ: we don't have all this any more (18.08.00) 
+% 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:
@@ -510,15 +512,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}}
@@ -612,9 +625,10 @@ 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
-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
@@ -627,6 +641,9 @@ indicate what elements of the frame to hide in full-screen mode:
 
 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}