added stock buttons support

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

diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex
index 6cbe7276e0fb61f4fdc141dfef672c3dea4f32c9..2f6d253925229b3d44080a26be837828112df2bc 100644 (file)
--- a/docs/latex/wx/frame.tex
+++ b/docs/latex/wx/frame.tex
@@ -35,32 +35,36 @@ 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{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.}
 \twocolitem{\windowstyle{wxFRAME\_NO\_TASKBAR}}{Creates an otherwise normal
 \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 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).
+frame but it does not appear in the taskbar under Windows or GTK+ (note that it
+will minimize to the desktop window under Windows which may seem strange to the
+users and thus it might be better to use this style only without
+wxMINIMIZE\_BOX style). In wxGTK, the flag is respected only if GTK+ is at
+least version 2.2 and the window manager supports 
+\urlref{\_NET\_WM\_STATE\_SKIP\_TASKBAR}{http://freedesktop.org/Standards/wm-spec/1.3/ar01s05.html} hint.

 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
 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

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


@@ -116,10 +120,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}.}
 


@@ -189,7 +193,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.}
 


@@ -226,7 +230,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.}
 


@@ -376,7 +380,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.}
 


@@ -406,7 +410,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.}
 


@@ -491,7 +495,7 @@ See also \helpref{wxIconBundle}{wxiconbundle}.
 %\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.
+%for all your wxWidgets application. Currently they show the same icon.

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


@@ -510,10 +514,10 @@ 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}
 
 
 \wxheading{See also}
 


@@ -521,13 +525,13 @@ Note that it is not possible to call this function twice for the same frame obje
 
 \membersection{wxFrame::SetShape}\label{wxframesetshape}
 
 
 \membersection{wxFrame::SetShape}\label{wxframesetshape}
 

-\func{bool}{SetShape}{\param{const wxRegion&}{ region}}
+\func{bool}{SetShape}{\param{const wxRegion\&}{ region}}

 
 If the platform supports it, sets the shape of the window to that
 
 If the platform supports it, sets the shape of the window to that

-depicted by \it{region}.  The system will not display or
+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
 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
+call {\it SetShape} again with an empty region.  Returns TRUE if the

 operation is successful.
 
 \membersection{wxFrame::SetStatusBar}\label{wxframesetstatusbar}
 operation is successful.
 
 \membersection{wxFrame::SetStatusBar}\label{wxframesetstatusbar}