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::GetTitle
}\label{wxtoplevelwindowgettitle
}
25 \constfunc{wxString
}{GetTitle
}{\void}
27 Gets a string containing the window title.
29 See
\helpref{wxTopLevelWindow::SetTitle
}{wxtoplevelwindowsettitle
}.
32 \membersection{wxTopLevelWindow::Iconize
}\label{wxtoplevelwindowiconize
}
34 \func{void
}{Iconize
}{\param{bool
}{ iconize
}}
36 Iconizes or restores the window.
38 \wxheading{Parameters
}
40 \docparam{iconize
}{If
\true, iconizes the window; if
\false, shows and restores it.
}
44 \helpref{wxTopLevelWindow::IsIconized
}{wxtoplevelwindowisiconized
},
\helpref{wxTopLevelWindow::Maximize
}{wxtoplevelwindowmaximize
}.
47 \membersection{wxTopLevelWindow::IsFullScreen
}\label{wxtoplevelwindowisfullscreen
}
49 \func{bool
}{IsFullScreen
}{\void}
51 Returns
\true if the window is in fullscreen mode.
55 \helpref{wxTopLevelWindow::ShowFullScreen
}{wxtoplevelwindowshowfullscreen
}
58 \membersection{wxTopLevelWindow::IsIconized
}\label{wxtoplevelwindowisiconized
}
60 \constfunc{bool
}{IsIconized
}{\void}
62 Returns
\true if the window is iconized.
65 \membersection{wxTopLevelWindow::IsMaximized
}\label{wxtoplevelwindowismaximized
}
67 \constfunc{bool
}{IsMaximized
}{\void}
69 Returns
\true if the window is maximized.
72 \membersection{wxTopLevelWindow::Maximize
}\label{wxtoplevelwindowmaximize
}
74 \func{void
}{Maximize
}{\param{bool
}{maximize
}}
76 Maximizes or restores the window.
78 \wxheading{Parameters
}
80 \docparam{maximize
}{If
\true, maximizes the window, otherwise it restores it.
}
84 This function only works under Windows.
88 \helpref{wxTopLevelWindow::Iconize
}{wxtoplevelwindowiconize
}
91 \membersection{wxTopLevelWindow::SetIcon
}\label{wxtoplevelwindowseticon
}
93 \func{void
}{SetIcon
}{\param{const wxIcon\&
}{icon
}}
95 Sets the icon for this window.
97 \wxheading{Parameters
}
99 \docparam{icon
}{The icon to associate with this window.
}
103 The window takes a `copy' of
{\it icon
}, but since it uses reference
104 counting, the copy is very quick. It is safe to delete
{\it icon
} after
105 calling this function.
107 See also
\helpref{wxIcon
}{wxicon
}.
110 \membersection{wxTopLevelWindow::SetIcons
}\label{wxtoplevelwindowseticons
}
112 \func{void
}{SetIcons
}{\param{const wxIconBundle\&
}{icons
}}
114 Sets the icons for this window.
116 \wxheading{Parameters
}
118 \docparam{icons
}{The icons to associate with this window.
}
120 See also
\helpref{wxIconBundle
}{wxiconbundle
}.
123 \membersection{wxTopLevelWindow::SetShape
}\label{wxtoplevelwindowsetshape
}
125 \func{bool
}{SetShape
}{\param{const wxRegion\&
}{ region
}}
127 If the platform supports it, sets the shape of the window to that
128 depicted by
{\it region
}. The system will not display or
129 respond to any mouse event for the pixels that lie outside of the
130 region. To reset the window to the normal rectangular shape simply
131 call
{\it SetShape
} again with an empty region. Returns TRUE if the
132 operation is successful.
135 \membersection{wxTopLevelWindow::SetTitle
}\label{wxtoplevelwindowsettitle
}
137 \func{virtual void
}{SetTitle
}{\param{const wxString\&
}{ title
}}
139 Sets the window title.
141 \wxheading{Parameters
}
143 \docparam{title
}{The window title.
}
147 \helpref{wxTopLevelWindow::GetTitle
}{wxtoplevelwindowgettitle
}
150 \membersection{wxTopLevelWindow::ShowFullScreen
}\label{wxtoplevelwindowshowfullscreen
}
152 \func{bool
}{ShowFullScreen
}{\param{bool
}{ show
},
\param{long
}{ style = wxFULLSCREEN
\_ALL}}
154 Depending on the value of
{\it show
} parameter the window is either shown full
155 screen or restored to its normal state.
{\it style
} is a bit list containing
156 some or all of the following values, which indicate what elements of the window
157 to hide in full-screen mode:
159 \begin{itemize
}\itemsep=
0pt
160 \item wxFULLSCREEN
\_NOMENUBAR
161 \item wxFULLSCREEN
\_NOTOOLBAR
162 \item wxFULLSCREEN
\_NOSTATUSBAR
163 \item wxFULLSCREEN
\_NOBORDER
164 \item wxFULLSCREEN
\_NOCAPTION
165 \item wxFULLSCREEN
\_ALL (all of the above)
168 This function has not been tested with MDI frames.
170 Note that showing a window full screen also actually
171 \helpref{Show()s
}{wxwindowshow
} if it hadn't been shown yet.
175 \helpref{wxTopLevelWindow::IsFullScreen
}{wxtoplevelwindowisfullscreen
}