docs/latex/wx/tlw.tex

   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
   9 %% License:     wxWidgets license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxTopLevelWindow}}\label{wxtoplevelwindow}
  13
  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.
  18
  19
  20 \latexignore{\rtfignore{\wxheading{Members}}}
  21
  22
  23 \membersection{wxTopLevelWindow::GetTitle}\label{wxtoplevelwindowgettitle}
  24
  25 \constfunc{wxString}{GetTitle}{\void}
  26
  27 Gets a string containing the window title.
  28
  29 See \helpref{wxTopLevelWindow::SetTitle}{wxtoplevelwindowsettitle}.
  30
  31
  32 \membersection{wxTopLevelWindow::Iconize}\label{wxtoplevelwindowiconize}
  33
  34 \func{void}{Iconize}{\param{bool}{ iconize}}
  35
  36 Iconizes or restores the window.
  37
  38 \wxheading{Parameters}
  39
  40 \docparam{iconize}{If \true, iconizes the window; if \false, shows and restores it.}
  41
  42 \wxheading{See also}
  43
  44 \helpref{wxTopLevelWindow::IsIconized}{wxtoplevelwindowisiconized}, \helpref{wxTopLevelWindow::Maximize}{wxtoplevelwindowmaximize}.
  45
  46
  47 \membersection{wxTopLevelWindow::IsFullScreen}\label{wxtoplevelwindowisfullscreen}
  48
  49 \func{bool}{IsFullScreen}{\void}
  50
  51 Returns \true if the window is in fullscreen mode.
  52
  53 \wxheading{See also}
  54
  55 \helpref{wxTopLevelWindow::ShowFullScreen}{wxtoplevelwindowshowfullscreen}
  56
  57
  58 \membersection{wxTopLevelWindow::IsIconized}\label{wxtoplevelwindowisiconized}
  59
  60 \constfunc{bool}{IsIconized}{\void}
  61
  62 Returns \true if the window is iconized.
  63
  64
  65 \membersection{wxTopLevelWindow::IsMaximized}\label{wxtoplevelwindowismaximized}
  66
  67 \constfunc{bool}{IsMaximized}{\void}
  68
  69 Returns \true if the window is maximized.
  70
  71
  72 \membersection{wxTopLevelWindow::Maximize}\label{wxtoplevelwindowmaximize}
  73
  74 \func{void}{Maximize}{\param{bool }{maximize}}
  75
  76 Maximizes or restores the window.
  77
  78 \wxheading{Parameters}
  79
  80 \docparam{maximize}{If \true, maximizes the window, otherwise it restores it.}
  81
  82 \wxheading{Remarks}
  83
  84 This function only works under Windows.
  85
  86 \wxheading{See also}
  87
  88 \helpref{wxTopLevelWindow::Iconize}{wxtoplevelwindowiconize}
  89
  90
  91 \membersection{wxTopLevelWindow::SetIcon}\label{wxtoplevelwindowseticon}
  92
  93 \func{void}{SetIcon}{\param{const wxIcon\& }{icon}}
  94
  95 Sets the icon for this window.
  96
  97 \wxheading{Parameters}
  98
  99 \docparam{icon}{The icon to associate with this window.}
 100
 101 \wxheading{Remarks}
 102
 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.
 106
 107 See also \helpref{wxIcon}{wxicon}.
 108
 109
 110 \membersection{wxTopLevelWindow::SetIcons}\label{wxtoplevelwindowseticons}
 111
 112 \func{void}{SetIcons}{\param{const wxIconBundle\& }{icons}}
 113
 114 Sets the icons for this window.
 115
 116 \wxheading{Parameters}
 117
 118 \docparam{icons}{The icons to associate with this window.}
 119
 120 See also \helpref{wxIconBundle}{wxiconbundle}.
 121
 122
 123 \membersection{wxTopLevelWindow::SetShape}\label{wxtoplevelwindowsetshape}
 124
 125 \func{bool}{SetShape}{\param{const wxRegion\&}{ region}}
 126
 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.
 133
 134
 135 \membersection{wxTopLevelWindow::SetTitle}\label{wxtoplevelwindowsettitle}
 136
 137 \func{virtual void}{SetTitle}{\param{const wxString\& }{ title}}
 138
 139 Sets the window title.
 140
 141 \wxheading{Parameters}
 142
 143 \docparam{title}{The window title.}
 144
 145 \wxheading{See also}
 146
 147 \helpref{wxTopLevelWindow::GetTitle}{wxtoplevelwindowgettitle}
 148
 149
 150 \membersection{wxTopLevelWindow::ShowFullScreen}\label{wxtoplevelwindowshowfullscreen}
 151
 152 \func{bool}{ShowFullScreen}{\param{bool}{ show}, \param{long}{ style = wxFULLSCREEN\_ALL}}
 153
 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:
 158
 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)
 166 \end{itemize}
 167
 168 This function has not been tested with MDI frames.
 169
 170 Note that showing a window full screen also actually
 171 \helpref{Show()s}{wxwindowshow} if it hadn't been shown yet.
 172
 173 \wxheading{See also}
 174
 175 \helpref{wxTopLevelWindow::IsFullScreen}{wxtoplevelwindowisfullscreen}
 176