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

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Name:        tlw.tex
%% Purpose:     wxTopLevelWindow documentation
%% Author:      Vadim Zeitlin
%% Modified by:
%% Created:     2004-09-07 (partly extracted from frame.tex)
%% RCS-ID:      $Id$
%% Copyright:   (c) 2004 Vadim Zeitlin
%% License:     wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section{\class{wxTopLevelWindow}}\label{wxtoplevelwindow}

wxTopLevelWindow is a common base class for \helpref{wxDialog}{wxdialog} and 
\helpref{wxFrame}{wxframe}. It is an abstract base class meaning that you never
work with objects of this class directly, but all of its methods are also
applicable for the two classes above.

\wxheading{Derived from}

\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/toplevel.h>


\latexignore{\rtfignore{\wxheading{Members}}}


\membersection{wxTopLevelWindow::GetIcon}\label{wxtoplevelwindowgeticon}

\constfunc{const wxIcon\&}{GetIcon}{\void}

Returns the standard icon of the window. The icon will be invalid if it hadn't
been previously set by \helpref{SetIcon}{wxtoplevelwindowseticon}.

\wxheading{See also}

\helpref{GetIcons}{wxtoplevelwindowgeticons}


\membersection{wxTopLevelWindow::GetIcons}\label{wxtoplevelwindowgeticons}

\constfunc{const wxIconBundle\&}{GetIcons}{\void}

Returns all icons associated with the window, there will be none of them if
neither \helpref{SetIcon}{wxtoplevelwindowseticon} nor 
\helpref{SetIcons}{wxtoplevelwindowseticons} had been called before.

Use \helpref{GetIcon}{wxtoplevelwindowgeticon} to get the main icon of the
window.

\wxheading{See also}

\helpref{wxIconBundle}{wxiconbundle}


\membersection{wxTopLevelWindow::GetTitle}\label{wxtoplevelwindowgettitle}

\constfunc{wxString}{GetTitle}{\void}

Gets a string containing the window title.

See \helpref{wxTopLevelWindow::SetTitle}{wxtoplevelwindowsettitle}.


\membersection{wxTopLevelWindow::IsActive}\label{wxtoplevelwindowisactive}

\constfunc{bool}{IsActive}{\void}

Returns \true if this window is currently active, i.e. if the user is currently
working with it.


\membersection{wxTopLevelWindow::Iconize}\label{wxtoplevelwindowiconize}

\func{void}{Iconize}{\param{bool}{ iconize}}

Iconizes or restores the window.

\wxheading{Parameters}

\docparam{iconize}{If \true, iconizes the window; if \false, shows and restores it.}

\wxheading{See also}

\helpref{wxTopLevelWindow::IsIconized}{wxtoplevelwindowisiconized}, \helpref{wxTopLevelWindow::Maximize}{wxtoplevelwindowmaximize}.


\membersection{wxTopLevelWindow::IsFullScreen}\label{wxtoplevelwindowisfullscreen}

\func{bool}{IsFullScreen}{\void}

Returns \true if the window is in fullscreen mode.

\wxheading{See also}

\helpref{wxTopLevelWindow::ShowFullScreen}{wxtoplevelwindowshowfullscreen}


\membersection{wxTopLevelWindow::IsIconized}\label{wxtoplevelwindowisiconized}

\constfunc{bool}{IsIconized}{\void}

Returns \true if the window is iconized.


\membersection{wxTopLevelWindow::IsMaximized}\label{wxtoplevelwindowismaximized}

\constfunc{bool}{IsMaximized}{\void}

Returns \true if the window is maximized.


\membersection{wxTopLevelWindow::Maximize}\label{wxtoplevelwindowmaximize}

\func{void}{Maximize}{\param{bool }{maximize}}

Maximizes or restores the window.

\wxheading{Parameters}

\docparam{maximize}{If \true, maximizes the window, otherwise it restores it.}

\wxheading{Remarks}

This function only works under Windows.

\wxheading{See also}

\helpref{wxTopLevelWindow::Iconize}{wxtoplevelwindowiconize}


\membersection{wxTopLevelWindow::RequestUserAttention}\label{wxtoplevelwindowrequestuserattention}

\func{void}{RequestUserAttention}{\param{int }{flags = wxUSER\_ATTENTION\_INFO}}

Use a system-dependent way to attract users attention to the window when it is
in background.

\arg{flags} may have the value of either \texttt{wxUSER\_ATTENTION\_INFO}
(default) or \texttt{wxUSER\_ATTENTION\_ERROR} which results in a more drastic
action. When in doubt, use the default value.

Note that this function should normally be only used when the application is
not already in foreground.

This function is currently implemented for Win32 where it flashes the
window icon in the taskbar, and for wxGTK with task bars supporting it.


\membersection{wxTopLevelWindow::SetIcon}\label{wxtoplevelwindowseticon}

\func{void}{SetIcon}{\param{const wxIcon\& }{icon}}

Sets the icon for this window.

\wxheading{Parameters}

\docparam{icon}{The icon to associate with this window.}

\wxheading{Remarks}

The window 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.

See also \helpref{wxIcon}{wxicon}.


\membersection{wxTopLevelWindow::SetIcons}\label{wxtoplevelwindowseticons}

\func{void}{SetIcons}{\param{const wxIconBundle\& }{icons}}

Sets several icons of different sizes for this window: this allows to use
different icons for different situations (e.g. task switching bar, taskbar,
window title bar) instead of scaling, with possibly bad looking results, the
only icon set by \helpref{SetIcon}{wxtoplevelwindowseticon}.

\wxheading{Parameters}

\docparam{icons}{The icons to associate with this window.}

\wxheading{See also}

\helpref{wxIconBundle}{wxiconbundle}.


\membersection{wxTopLevelWindow::SetLeftMenu}\label{wxtoplevelwindowsetleftmenu}

\func{void}{SetLeftMenu}{\param{int}{ id = wxID\_ANY}, \param{const wxString\&}{ label = wxEmptyString}, \param{wxMenu *}{ subMenu = NULL}}

Sets action or menu activated by pressing left hardware button on the smart phones.
Unavailable on full keyboard machines.

\wxheading{Parameters}

\docparam{id}{Identifier for this button.}

\docparam{label}{Text to be displayed on the screen area dedicated to this hardware button.}

\docparam{subMenu}{The menu to be opened after pressing this hardware button.}

\wxheading{See also}

\helpref{wxTopLevelWindow::SetRightMenu}{wxtoplevelwindowsetrightmenu}.


\membersection{wxTopLevelWindow::SetRightMenu}\label{wxtoplevelwindowsetrightmenu}

\func{void}{SetRightMenu}{\param{int}{ id = wxID\_ANY}, \param{const wxString\&}{ label = wxEmptyString}, \param{wxMenu *}{ subMenu = NULL}}

Sets action or menu activated by pressing right hardware button on the smart phones.
Unavailable on full keyboard machines.

\wxheading{Parameters}

\docparam{id}{Identifier for this button.}

\docparam{label}{Text to be displayed on the screen area dedicated to this hardware button.}

\docparam{subMenu}{The menu to be opened after pressing this hardware button.}

\wxheading{See also}

\helpref{wxTopLevelWindow::SetLeftMenu}{wxtoplevelwindowsetleftmenu}.


\membersection{wxTopLevelWindow::SetShape}\label{wxtoplevelwindowsetshape}

\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{wxTopLevelWindow::SetTitle}\label{wxtoplevelwindowsettitle}

\func{virtual void}{SetTitle}{\param{const wxString\& }{ title}}

Sets the window title.

\wxheading{Parameters}

\docparam{title}{The window title.}

\wxheading{See also}

\helpref{wxTopLevelWindow::GetTitle}{wxtoplevelwindowgettitle}


\membersection{wxTopLevelWindow::ShowFullScreen}\label{wxtoplevelwindowshowfullscreen}

\func{bool}{ShowFullScreen}{\param{bool}{ show}, \param{long}{ style = wxFULLSCREEN\_ALL}}

Depending on the value of {\it show} parameter the window 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 window
to hide in full-screen mode:

\begin{itemize}\itemsep=0pt
\item wxFULLSCREEN\_NOMENUBAR
\item wxFULLSCREEN\_NOTOOLBAR
\item wxFULLSCREEN\_NOSTATUSBAR
\item wxFULLSCREEN\_NOBORDER
\item wxFULLSCREEN\_NOCAPTION
\item wxFULLSCREEN\_ALL (all of the above)
\end{itemize}

This function has not been tested with MDI frames.

Note that showing a window full screen also actually
\helpref{Show()s}{wxwindowshow} if it hadn't been shown yet.

\wxheading{See also}

\helpref{wxTopLevelWindow::IsFullScreen}{wxtoplevelwindowisfullscreen}
Commit	Line	Data
834ed994 VZ	1	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
	2	%% Name: tlw.tex
	3	%% Purpose: wxTopLevelWindow documentation
	4	%% Author: Vadim Zeitlin
	5	%% Modified by:
	6	%% Created: 2004-09-07 (partly extracted from frame.tex)
	7	%% RCS-ID: $Id$
	8	%% Copyright: (c) 2004 Vadim Zeitlin
8795498c	9	%% License: wxWindows license
834ed994 VZ	10	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
	11
	12	\section{\class{wxTopLevelWindow}}\label{wxtoplevelwindow}
	13
	14	wxTopLevelWindow is a common base class for \helpref{wxDialog}{wxdialog} and
9eace708	15	\helpref{wxFrame}{wxframe}. It is an abstract base class meaning that you never
834ed994 VZ	16	work with objects of this class directly, but all of its methods are also
	17	applicable for the two classes above.
	18
9eace708 VZ	19	\wxheading{Derived from}
	20
	21	\helpref{wxWindow}{wxwindow}\\
	22	\helpref{wxEvtHandler}{wxevthandler}\\
	23	\helpref{wxObject}{wxobject}
	24
	25	\wxheading{Include files}
	26
	27	<wx/toplevel.h>
	28
834ed994 VZ	29
	30	\latexignore{\rtfignore{\wxheading{Members}}}
	31
	32
5a8e93c4 VZ	33	\membersection{wxTopLevelWindow::GetIcon}\label{wxtoplevelwindowgeticon}
	34
	35	\constfunc{const wxIcon\&}{GetIcon}{\void}
	36
	37	Returns the standard icon of the window. The icon will be invalid if it hadn't
	38	been previously set by \helpref{SetIcon}{wxtoplevelwindowseticon}.
	39
	40	\wxheading{See also}
	41
	42	\helpref{GetIcons}{wxtoplevelwindowgeticons}
	43
	44
	45	\membersection{wxTopLevelWindow::GetIcons}\label{wxtoplevelwindowgeticons}
	46
	47	\constfunc{const wxIconBundle\&}{GetIcons}{\void}
	48
	49	Returns all icons associated with the window, there will be none of them if
	50	neither \helpref{SetIcon}{wxtoplevelwindowseticon} nor
	51	\helpref{SetIcons}{wxtoplevelwindowseticons} had been called before.
	52
	53	Use \helpref{GetIcon}{wxtoplevelwindowgeticon} to get the main icon of the
	54	window.
	55
	56	\wxheading{See also}
	57
	58	\helpref{wxIconBundle}{wxiconbundle}
	59
	60
834ed994 VZ	61	\membersection{wxTopLevelWindow::GetTitle}\label{wxtoplevelwindowgettitle}
	62
	63	\constfunc{wxString}{GetTitle}{\void}
	64
	65	Gets a string containing the window title.
	66
	67	See \helpref{wxTopLevelWindow::SetTitle}{wxtoplevelwindowsettitle}.
	68
	69
6b30a44e VZ	70	\membersection{wxTopLevelWindow::IsActive}\label{wxtoplevelwindowisactive}
	71
	72	\constfunc{bool}{IsActive}{\void}
	73
	74	Returns \true if this window is currently active, i.e. if the user is currently
	75	working with it.
	76
	77
834ed994 VZ	78	\membersection{wxTopLevelWindow::Iconize}\label{wxtoplevelwindowiconize}
	79
	80	\func{void}{Iconize}{\param{bool}{ iconize}}
	81
	82	Iconizes or restores the window.
	83
	84	\wxheading{Parameters}
	85
	86	\docparam{iconize}{If \true, iconizes the window; if \false, shows and restores it.}
	87
	88	\wxheading{See also}
	89
	90	\helpref{wxTopLevelWindow::IsIconized}{wxtoplevelwindowisiconized}, \helpref{wxTopLevelWindow::Maximize}{wxtoplevelwindowmaximize}.
	91
	92
	93	\membersection{wxTopLevelWindow::IsFullScreen}\label{wxtoplevelwindowisfullscreen}
	94
	95	\func{bool}{IsFullScreen}{\void}
	96
	97	Returns \true if the window is in fullscreen mode.
	98
	99	\wxheading{See also}
	100
	101	\helpref{wxTopLevelWindow::ShowFullScreen}{wxtoplevelwindowshowfullscreen}
	102
	103
	104	\membersection{wxTopLevelWindow::IsIconized}\label{wxtoplevelwindowisiconized}
	105
	106	\constfunc{bool}{IsIconized}{\void}
	107
	108	Returns \true if the window is iconized.
	109
	110
	111	\membersection{wxTopLevelWindow::IsMaximized}\label{wxtoplevelwindowismaximized}
	112
	113	\constfunc{bool}{IsMaximized}{\void}
	114
	115	Returns \true if the window is maximized.
	116
	117
	118	\membersection{wxTopLevelWindow::Maximize}\label{wxtoplevelwindowmaximize}
	119
	120	\func{void}{Maximize}{\param{bool }{maximize}}
	121
	122	Maximizes or restores the window.
	123
	124	\wxheading{Parameters}
	125
	126	\docparam{maximize}{If \true, maximizes the window, otherwise it restores it.}
	127
	128	\wxheading{Remarks}
	129
	130	This function only works under Windows.
	131
	132	\wxheading{See also}
	133
	134	\helpref{wxTopLevelWindow::Iconize}{wxtoplevelwindowiconize}
	135
	136
dc92adaf VZ	137	\membersection{wxTopLevelWindow::RequestUserAttention}\label{wxtoplevelwindowrequestuserattention}
	138
	139	\func{void}{RequestUserAttention}{\param{int }{flags = wxUSER\_ATTENTION\_INFO}}
	140
	141	Use a system-dependent way to attract users attention to the window when it is
	142	in background.
	143
	144	\arg{flags} may have the value of either \texttt{wxUSER\_ATTENTION\_INFO}
	145	(default) or \texttt{wxUSER\_ATTENTION\_ERROR} which results in a more drastic
	146	action. When in doubt, use the default value.
	147
	148	Note that this function should normally be only used when the application is
	149	not already in foreground.
	150
dca92ddf MR	151	This function is currently implemented for Win32 where it flashes the
dca92ddf MR	152	window icon in the taskbar, and for wxGTK with task bars supporting it.
dc92adaf VZ	153
dc92adaf VZ	154
834ed994 VZ	155	\membersection{wxTopLevelWindow::SetIcon}\label{wxtoplevelwindowseticon}
	156
	157	\func{void}{SetIcon}{\param{const wxIcon\& }{icon}}
	158
	159	Sets the icon for this window.
	160
	161	\wxheading{Parameters}
	162
	163	\docparam{icon}{The icon to associate with this window.}
	164
	165	\wxheading{Remarks}
	166
	167	The window takes a `copy' of {\it icon}, but since it uses reference
	168	counting, the copy is very quick. It is safe to delete {\it icon} after
	169	calling this function.
	170
	171	See also \helpref{wxIcon}{wxicon}.
	172
	173
	174	\membersection{wxTopLevelWindow::SetIcons}\label{wxtoplevelwindowseticons}
	175
	176	\func{void}{SetIcons}{\param{const wxIconBundle\& }{icons}}
	177
5a8e93c4 VZ	178	Sets several icons of different sizes for this window: this allows to use
	179	different icons for different situations (e.g. task switching bar, taskbar,
	180	window title bar) instead of scaling, with possibly bad looking results, the
	181	only icon set by \helpref{SetIcon}{wxtoplevelwindowseticon}.
834ed994 VZ	182
	183	\wxheading{Parameters}
	184
	185	\docparam{icons}{The icons to associate with this window.}
	186
5a8e93c4 VZ	187	\wxheading{See also}
	188
	189	\helpref{wxIconBundle}{wxiconbundle}.
834ed994 VZ	190
834ed994 VZ	191
9ca7505f WS	192	\membersection{wxTopLevelWindow::SetLeftMenu}\label{wxtoplevelwindowsetleftmenu}
9ca7505f WS	193
7c57ddc3	194	\func{void}{SetLeftMenu}{\param{int}{ id = wxID\_ANY}, \param{const wxString\&}{ label = wxEmptyString}, \param{wxMenu *}{ subMenu = NULL}}
9ca7505f WS	195
	196	Sets action or menu activated by pressing left hardware button on the smart phones.
	197	Unavailable on full keyboard machines.
	198
	199	\wxheading{Parameters}
	200
	201	\docparam{id}{Identifier for this button.}
	202
	203	\docparam{label}{Text to be displayed on the screen area dedicated to this hardware button.}
	204
	205	\docparam{subMenu}{The menu to be opened after pressing this hardware button.}
	206
	207	\wxheading{See also}
	208
	209	\helpref{wxTopLevelWindow::SetRightMenu}{wxtoplevelwindowsetrightmenu}.
	210
	211
	212	\membersection{wxTopLevelWindow::SetRightMenu}\label{wxtoplevelwindowsetrightmenu}
	213
7c57ddc3	214	\func{void}{SetRightMenu}{\param{int}{ id = wxID\_ANY}, \param{const wxString\&}{ label = wxEmptyString}, \param{wxMenu *}{ subMenu = NULL}}
9ca7505f WS	215
	216	Sets action or menu activated by pressing right hardware button on the smart phones.
	217	Unavailable on full keyboard machines.
	218
	219	\wxheading{Parameters}
	220
	221	\docparam{id}{Identifier for this button.}
	222
	223	\docparam{label}{Text to be displayed on the screen area dedicated to this hardware button.}
	224
	225	\docparam{subMenu}{The menu to be opened after pressing this hardware button.}
	226
	227	\wxheading{See also}
	228
	229	\helpref{wxTopLevelWindow::SetLeftMenu}{wxtoplevelwindowsetleftmenu}.
	230
	231
834ed994 VZ	232	\membersection{wxTopLevelWindow::SetShape}\label{wxtoplevelwindowsetshape}
	233
	234	\func{bool}{SetShape}{\param{const wxRegion\&}{ region}}
	235
	236	If the platform supports it, sets the shape of the window to that
	237	depicted by {\it region}. The system will not display or
	238	respond to any mouse event for the pixels that lie outside of the
	239	region. To reset the window to the normal rectangular shape simply
	240	call {\it SetShape} again with an empty region. Returns TRUE if the
	241	operation is successful.
	242
	243
	244	\membersection{wxTopLevelWindow::SetTitle}\label{wxtoplevelwindowsettitle}
	245
	246	\func{virtual void}{SetTitle}{\param{const wxString\& }{ title}}
	247
	248	Sets the window title.
	249
	250	\wxheading{Parameters}
	251
	252	\docparam{title}{The window title.}
	253
	254	\wxheading{See also}
	255
	256	\helpref{wxTopLevelWindow::GetTitle}{wxtoplevelwindowgettitle}
	257
	258
	259	\membersection{wxTopLevelWindow::ShowFullScreen}\label{wxtoplevelwindowshowfullscreen}
	260
	261	\func{bool}{ShowFullScreen}{\param{bool}{ show}, \param{long}{ style = wxFULLSCREEN\_ALL}}
	262
	263	Depending on the value of {\it show} parameter the window is either shown full
	264	screen or restored to its normal state. {\it style} is a bit list containing
	265	some or all of the following values, which indicate what elements of the window
	266	to hide in full-screen mode:
	267
	268	\begin{itemize}\itemsep=0pt
	269	\item wxFULLSCREEN\_NOMENUBAR
	270	\item wxFULLSCREEN\_NOTOOLBAR
	271	\item wxFULLSCREEN\_NOSTATUSBAR
	272	\item wxFULLSCREEN\_NOBORDER
	273	\item wxFULLSCREEN\_NOCAPTION
	274	\item wxFULLSCREEN\_ALL (all of the above)
	275	\end{itemize}
	276
	277	This function has not been tested with MDI frames.
	278
	279	Note that showing a window full screen also actually
	280	\helpref{Show()s}{wxwindowshow} if it hadn't been shown yet.
	281
	282	\wxheading{See also}
	283
	284	\helpref{wxTopLevelWindow::IsFullScreen}{wxtoplevelwindowisfullscreen}
	285