X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/716645d36139d6522822b7ae80e509e812c6c693..fe161a2685012cf90bb5bfe95f2260aee71d8ad7:/docs/latex/wx/frame.tex?ds=sidebyside

diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex
index e351ee10dc..89e56d46bc 100644
--- a/docs/latex/wx/frame.tex
+++ b/docs/latex/wx/frame.tex
@@ -35,7 +35,6 @@ application windows.
 \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{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.}
@@ -48,19 +47,21 @@ Has no effect under other platforms.}
 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
-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
-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)}
+\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
-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}.
@@ -73,7 +74,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
@@ -116,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
-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
-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}.}
 
@@ -189,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
-wxWindows.}
+wxWidgets.}
 
 \docparam{name}{The status bar window name.}
 
@@ -226,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
-wxWindows.}
+wxWidgets.}
 
 \docparam{name}{The toolbar window name.}
 
@@ -376,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
-wxWindows.}
+wxWidgets.}
 
 \docparam{name}{The window name.}
 
@@ -406,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
-wxWindows.}
+wxWidgets.}
 
 \docparam{name}{The toolbar window name.}
 
@@ -466,7 +467,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:
@@ -491,7 +492,7 @@ See also \helpref{wxIconBundle}{wxiconbundle}.
 %\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.
+%for all your wxWidgets application. Currently they show the same icon.
 
 \membersection{wxFrame::SetMenuBar}\label{wxframesetmenubar}
 
@@ -510,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).
 
-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}}
@@ -628,7 +640,7 @@ to hide in full-screen mode:
 
 This function has not been tested with MDI frames.
 
-Note that showing a frame full screen also actually 
+Note that showing a frame full screen also actually
 \helpref{Show()s}{wxwindowshow} if it hadn't been shown yet.
 
 \wxheading{See also}
