1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %% Purpose: wxTopLevelWindow documentation
4 %% Author: Vadim Zeitlin
6 %% Created: 2004-09-07 (partly extracted from frame.tex)
8 %% Copyright: (c) 2004 Vadim Zeitlin
9 %% License: wxWidgets license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12 \section{\class{wxTopLevelWindow
}}\label{wxtoplevelwindow
}
14 wxTopLevelWindow is a common base class for
\helpref{wxDialog
}{wxdialog
} and
15 \helpref{wxTopLevelWindow
}{wxtoplevelwindow
}. It is an abstract base class meaning that you never
16 work with objects of this class directly, but all of its methods are also
17 applicable for the two classes above.
20 \latexignore{\rtfignore{\wxheading{Members
}}}
23 \membersection{wxTopLevelWindow::GetIcon
}\label{wxtoplevelwindowgeticon
}
25 \constfunc{const wxIcon\&
}{GetIcon
}{\void}
27 Returns the standard icon of the window. The icon will be invalid if it hadn't
28 been previously set by
\helpref{SetIcon
}{wxtoplevelwindowseticon
}.
32 \helpref{GetIcons
}{wxtoplevelwindowgeticons
}
35 \membersection{wxTopLevelWindow::GetIcons
}\label{wxtoplevelwindowgeticons
}
37 \constfunc{const wxIconBundle\&
}{GetIcons
}{\void}
39 Returns all icons associated with the window, there will be none of them if
40 neither
\helpref{SetIcon
}{wxtoplevelwindowseticon
} nor
41 \helpref{SetIcons
}{wxtoplevelwindowseticons
} had been called before.
43 Use
\helpref{GetIcon
}{wxtoplevelwindowgeticon
} to get the main icon of the
48 \helpref{wxIconBundle
}{wxiconbundle
}
51 \membersection{wxTopLevelWindow::GetTitle
}\label{wxtoplevelwindowgettitle
}
53 \constfunc{wxString
}{GetTitle
}{\void}
55 Gets a string containing the window title.
57 See
\helpref{wxTopLevelWindow::SetTitle
}{wxtoplevelwindowsettitle
}.
60 \membersection{wxTopLevelWindow::Iconize
}\label{wxtoplevelwindowiconize
}
62 \func{void
}{Iconize
}{\param{bool
}{ iconize
}}
64 Iconizes or restores the window.
66 \wxheading{Parameters
}
68 \docparam{iconize
}{If
\true, iconizes the window; if
\false, shows and restores it.
}
72 \helpref{wxTopLevelWindow::IsIconized
}{wxtoplevelwindowisiconized
},
\helpref{wxTopLevelWindow::Maximize
}{wxtoplevelwindowmaximize
}.
75 \membersection{wxTopLevelWindow::IsFullScreen
}\label{wxtoplevelwindowisfullscreen
}
77 \func{bool
}{IsFullScreen
}{\void}
79 Returns
\true if the window is in fullscreen mode.
83 \helpref{wxTopLevelWindow::ShowFullScreen
}{wxtoplevelwindowshowfullscreen
}
86 \membersection{wxTopLevelWindow::IsIconized
}\label{wxtoplevelwindowisiconized
}
88 \constfunc{bool
}{IsIconized
}{\void}
90 Returns
\true if the window is iconized.
93 \membersection{wxTopLevelWindow::IsMaximized
}\label{wxtoplevelwindowismaximized
}
95 \constfunc{bool
}{IsMaximized
}{\void}
97 Returns
\true if the window is maximized.
100 \membersection{wxTopLevelWindow::Maximize
}\label{wxtoplevelwindowmaximize
}
102 \func{void
}{Maximize
}{\param{bool
}{maximize
}}
104 Maximizes or restores the window.
106 \wxheading{Parameters
}
108 \docparam{maximize
}{If
\true, maximizes the window, otherwise it restores it.
}
112 This function only works under Windows.
116 \helpref{wxTopLevelWindow::Iconize
}{wxtoplevelwindowiconize
}
119 \membersection{wxTopLevelWindow::SetIcon
}\label{wxtoplevelwindowseticon
}
121 \func{void
}{SetIcon
}{\param{const wxIcon\&
}{icon
}}
123 Sets the icon for this window.
125 \wxheading{Parameters
}
127 \docparam{icon
}{The icon to associate with this window.
}
131 The window takes a `copy' of
{\it icon
}, but since it uses reference
132 counting, the copy is very quick. It is safe to delete
{\it icon
} after
133 calling this function.
135 See also
\helpref{wxIcon
}{wxicon
}.
138 \membersection{wxTopLevelWindow::SetIcons
}\label{wxtoplevelwindowseticons
}
140 \func{void
}{SetIcons
}{\param{const wxIconBundle\&
}{icons
}}
142 Sets several icons of different sizes for this window: this allows to use
143 different icons for different situations (e.g. task switching bar, taskbar,
144 window title bar) instead of scaling, with possibly bad looking results, the
145 only icon set by
\helpref{SetIcon
}{wxtoplevelwindowseticon
}.
147 \wxheading{Parameters
}
149 \docparam{icons
}{The icons to associate with this window.
}
153 \helpref{wxIconBundle
}{wxiconbundle
}.
156 \membersection{wxTopLevelWindow::SetShape
}\label{wxtoplevelwindowsetshape
}
158 \func{bool
}{SetShape
}{\param{const wxRegion\&
}{ region
}}
160 If the platform supports it, sets the shape of the window to that
161 depicted by
{\it region
}. The system will not display or
162 respond to any mouse event for the pixels that lie outside of the
163 region. To reset the window to the normal rectangular shape simply
164 call
{\it SetShape
} again with an empty region. Returns TRUE if the
165 operation is successful.
168 \membersection{wxTopLevelWindow::SetTitle
}\label{wxtoplevelwindowsettitle
}
170 \func{virtual void
}{SetTitle
}{\param{const wxString\&
}{ title
}}
172 Sets the window title.
174 \wxheading{Parameters
}
176 \docparam{title
}{The window title.
}
180 \helpref{wxTopLevelWindow::GetTitle
}{wxtoplevelwindowgettitle
}
183 \membersection{wxTopLevelWindow::ShowFullScreen
}\label{wxtoplevelwindowshowfullscreen
}
185 \func{bool
}{ShowFullScreen
}{\param{bool
}{ show
},
\param{long
}{ style = wxFULLSCREEN
\_ALL}}
187 Depending on the value of
{\it show
} parameter the window is either shown full
188 screen or restored to its normal state.
{\it style
} is a bit list containing
189 some or all of the following values, which indicate what elements of the window
190 to hide in full-screen mode:
192 \begin{itemize
}\itemsep=
0pt
193 \item wxFULLSCREEN
\_NOMENUBAR
194 \item wxFULLSCREEN
\_NOTOOLBAR
195 \item wxFULLSCREEN
\_NOSTATUSBAR
196 \item wxFULLSCREEN
\_NOBORDER
197 \item wxFULLSCREEN
\_NOCAPTION
198 \item wxFULLSCREEN
\_ALL (all of the above)
201 This function has not been tested with MDI frames.
203 Note that showing a window full screen also actually
204 \helpref{Show()s
}{wxwindowshow
} if it hadn't been shown yet.
208 \helpref{wxTopLevelWindow::IsFullScreen
}{wxtoplevelwindowisfullscreen
}