docs/latex/wx/icon.tex

   1 \section{\class{wxIcon}}\label{wxicon}
   2
   3 An icon is a small rectangular bitmap usually used for denoting a
   4 minimized application. It differs from a wxBitmap in always
   5 having a mask associated with it for transparent drawing. On some platforms,
   6 icons and bitmaps are implemented identically, since there is no real distinction between
   7 a wxBitmap with a mask and an icon; and there is no specific icon format on
   8 some platforms (X-based applications usually standardize on XPMs for small bitmaps
   9 and icons). However, some platforms (such as Windows) make the distinction, so
  10 a separate class is provided.
  11
  12 \wxheading{Derived from}
  13
  14 \helpref{wxBitmap}{wxbitmap}\\
  15 \helpref{wxGDIObject}{wxgdiobject}\\
  16 \helpref{wxObject}{wxobject}
  17
  18 \wxheading{Include files}
  19
  20 <wx/icon.h>
  21
  22 \wxheading{Predefined objects}
  23
  24 Objects:
  25
  26 {\bf wxNullIcon}
  27
  28 \wxheading{Remarks}
  29
  30 It is usually desirable to associate a pertinent icon with a frame. Icons
  31 can also be used for other purposes, for example with \helpref{wxTreeCtrl}{wxtreectrl}
  32 and \helpref{wxListCtrl}{wxlistctrl}.
  33
  34 Icons have different formats on different platforms.
  35 Therefore, separate icons will usually be created for the different
  36 environments.  Platform-specific methods for creating a {\bf wxIcon}\rtfsp
  37 structure are catered for, and this is an occasion where conditional
  38 compilation will probably be required.
  39
  40 Note that a new icon must be created for every time the icon is to be
  41 used for a new window. In Windows, the icon will not be
  42 reloaded if it has already been used. An icon allocated to a frame will
  43 be deleted when the frame is deleted.
  44
  45 For more information please see \helpref{Bitmap and icon overview}{wxbitmapoverview}.
  46
  47 \wxheading{See also}
  48
  49 \helpref{Bitmap and icon overview}{wxbitmapoverview}, \helpref{supported bitmap file formats}{supportedbitmapformats},
  50 \helpref{wxDC::DrawIcon}{wxdcdrawicon}, \helpref{wxCursor}{wxcursor}
  51
  52 \latexignore{\rtfignore{\wxheading{Members}}}
  53
  54 \membersection{wxIcon::wxIcon}\label{wxiconconstr}
  55
  56 \func{}{wxIcon}{\void}
  57
  58 Default constructor.
  59
  60 \func{}{wxIcon}{\param{const wxIcon\& }{icon}}
  61
  62 Copy constructor.
  63
  64 \func{}{wxIcon}{\param{void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
  65
  66 Creates an icon from the given data, which can be of arbitrary type.
  67
  68 \func{}{wxIcon}{\param{const char}{ bits[]}, \param{int}{ width}, \param{int}{ height}\\
  69   \param{int}{ depth = 1}}
  70
  71 Creates an icon from an array of bits.
  72
  73 \func{}{wxIcon}{\param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
  74
  75 Creates a new icon.
  76
  77 \func{}{wxIcon}{\param{char**}{ bits}}
  78
  79 \func{}{wxIcon}{\param{const char**}{ bits}}
  80
  81 Creates an icon from XPM data.
  82
  83 \func{}{wxIcon}{\param{const wxString\& }{name}, \param{long}{ type},
  84   \param{int}{ desiredWidth = -1}, \param{int}{ desiredHeight = -1}}
  85
  86 Loads an icon from a file or resource.
  87
  88 \wxheading{Parameters}
  89
  90 \docparam{bits}{Specifies an array of pixel values.}
  91
  92 \docparam{width}{Specifies the width of the icon.}
  93
  94 \docparam{height}{Specifies the height of the icon.}
  95
  96 \docparam{desiredWidth}{Specifies the desired width of the icon. This
  97 parameter only has an effect in Windows (32-bit) where icon resources can contain
  98 several icons of different sizes.}
  99
 100 \docparam{desiredWidth}{Specifies the desired height of the icon. This
 101 parameter only has an effect in Windows (32-bit) where icon resources can contain
 102 several icons of different sizes.}
 103
 104 \docparam{depth}{Specifies the depth of the icon. If this is omitted, the display depth of the
 105 screen is used.}
 106
 107 \docparam{name}{This can refer to a resource name under MS Windows, or a filename under MS Windows and X.
 108 Its meaning is determined by the {\it flags} parameter.}
 109
 110 \docparam{type}{May be one of the following:
 111
 112 \twocolwidtha{5cm}
 113 \begin{twocollist}
 114 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_ICO}}}{Load a Windows icon file.}
 115 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_ICO\_RESOURCE}}}{Load a Windows icon from the resource database.}
 116 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_GIF}}}{Load a GIF bitmap file.}
 117 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_XBM}}}{Load an X bitmap file.}
 118 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_XPM}}}{Load an XPM bitmap file.}
 119 %\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_RESOURCE}}}{Load a Windows resource name.}
 120 \end{twocollist}
 121
 122 The validity of these flags depends on the platform and wxWindows configuration.
 123 If all possible wxWindows settings are used, the Windows platform supports ICO file, ICO resource,
 124 XPM data, and XPM file. Under wxGTK, the available formats are BMP file, XPM data, XPM file, and PNG file.
 125 Under wxMotif, the available formats are XBM data, XBM file, XPM data, XPM file.}
 126
 127 \wxheading{Remarks}
 128
 129 The first form constructs an icon object with no data; an assignment or another member function such as Create
 130 or LoadFile must be called subsequently.
 131
 132 The second and third forms provide copy constructors. Note that these do not copy the
 133 icon data, but instead a pointer to the data, keeping a reference count. They are therefore
 134 very efficient operations.
 135
 136 The fourth form constructs an icon from data whose type and value depends on
 137 the value of the {\it type} argument.
 138
 139 The fifth form constructs a (usually monochrome) icon from an array of pixel values, under both
 140 X and Windows.
 141
 142 The sixth form constructs a new icon.
 143
 144 The seventh form constructs an icon from pixmap (XPM) data, if wxWindows has been configured
 145 to incorporate this feature.
 146
 147 To use this constructor, you must first include an XPM file. For
 148 example, assuming that the file {\tt mybitmap.xpm} contains an XPM array
 149 of character pointers called mybitmap:
 150
 151 \begin{verbatim}
 152 #include "mybitmap.xpm"
 153
 154 ...
 155
 156 wxIcon *icon = new wxIcon(mybitmap);
 157 \end{verbatim}
 158
 159 A macro, wxICON, is available which creates an icon using an XPM
 160 on the appropriate platform, or an icon resource on Windows.
 161
 162 \begin{verbatim}
 163 wxIcon icon(wxICON(mondrian));
 164
 165 // Equivalent to:
 166
 167 #if defined(__WXGTK__) || defined(__WXMOTIF__)
 168 wxIcon icon(mondrian_xpm);
 169 #endif
 170
 171 #if defined(__WXMSW__)
 172 wxIcon icon("mondrian");
 173 #endif
 174 \end{verbatim}
 175
 176 The eighth form constructs an icon from a file or resource. {\it name} can refer
 177 to a resource name under MS Windows, or a filename under MS Windows and X.
 178
 179 Under Windows, {\it type} defaults to wxBITMAP\_TYPE\_ICO\_RESOURCE.
 180 Under X, {\it type} defaults to wxBITMAP\_TYPE\_XPM.
 181
 182 \wxheading{See also}
 183
 184 \helpref{wxIcon::LoadFile}{wxiconloadfile}
 185
 186 \membersection{wxIcon::\destruct{wxIcon}}
 187
 188 \func{}{\destruct{wxIcon}}{\void}
 189
 190 Destroys the wxIcon object and possibly the underlying icon data.
 191 Because reference counting is used, the icon may not actually be
 192 destroyed at this point - only when the reference count is zero will the
 193 data be deleted.
 194
 195 If the application omits to delete the icon explicitly, the icon will be
 196 destroyed automatically by wxWindows when the application exits.
 197
 198 Do not delete an icon that is selected into a memory device context.
 199
 200 \membersection{wxIcon::GetDepth}
 201
 202 \constfunc{int}{GetDepth}{\void}
 203
 204 Gets the colour depth of the icon. A value of 1 indicates a
 205 monochrome icon.
 206
 207 \membersection{wxIcon::GetHeight}\label{wxicongetheight}
 208
 209 \constfunc{int}{GetHeight}{\void}
 210
 211 Gets the height of the icon in pixels.
 212
 213 \membersection{wxIcon::GetWidth}\label{wxicongetwidth}
 214
 215 \constfunc{int}{GetWidth}{\void}
 216
 217 Gets the width of the icon in pixels.
 218
 219 \wxheading{See also}
 220
 221 \helpref{wxIcon::GetHeight}{wxicongetheight}
 222
 223 \membersection{wxIcon::LoadFile}\label{wxiconloadfile}
 224
 225 \func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type}}
 226
 227 Loads an icon from a file or resource.
 228
 229 \wxheading{Parameters}
 230
 231 \docparam{name}{Either a filename or a Windows resource name.
 232 The meaning of {\it name} is determined by the {\it type} parameter.}
 233
 234 \docparam{type}{One of the following values:
 235
 236 \twocolwidtha{5cm}
 237 \begin{twocollist}
 238 \twocolitem{{\bf wxBITMAP\_TYPE\_ICO}}{Load a Windows icon file.}
 239 \twocolitem{{\bf wxBITMAP\_TYPE\_ICO\_RESOURCE}}{Load a Windows icon from the resource database.}
 240 \twocolitem{{\bf wxBITMAP\_TYPE\_GIF}}{Load a GIF bitmap file.}
 241 \twocolitem{{\bf wxBITMAP\_TYPE\_XBM}}{Load an X bitmap file.}
 242 \twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Load an XPM bitmap file.}
 243 \end{twocollist}
 244
 245 The validity of these flags depends on the platform and wxWindows configuration.}
 246
 247 \wxheading{Return value}
 248
 249 TRUE if the operation succeeded, FALSE otherwise.
 250
 251 \wxheading{See also}
 252
 253 \helpref{wxIcon::wxIcon}{wxiconconstr}
 254
 255 \membersection{wxIcon::Ok}\label{wxiconok}
 256
 257 \constfunc{bool}{Ok}{\void}
 258
 259 Returns TRUE if icon data is present.
 260
 261 \begin{comment}
 262 \membersection{wxIcon::SaveFile}\label{wxiconsavefile}
 263
 264 \func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{int}{ type}, \param{wxPalette* }{palette = NULL}}
 265
 266 Saves an icon in the named file.
 267
 268 \wxheading{Parameters}
 269
 270 \docparam{name}{A filename. The meaning of {\it name} is determined by the {\it type} parameter.}
 271
 272 \docparam{type}{One of the following values:
 273
 274 \twocolwidtha{5cm}
 275 \begin{twocollist}
 276 \twocolitem{{\bf wxBITMAP\_TYPE\_ICO}}{Save a Windows icon file.}
 277 %\twocolitem{{\bf wxBITMAP\_TYPE\_GIF}}{Save a GIF icon file.}
 278 %\twocolitem{{\bf wxBITMAP\_TYPE\_XBM}}{Save an X bitmap file.}
 279 \twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Save an XPM bitmap file.}
 280 \end{twocollist}
 281
 282 The validity of these flags depends on the platform and wxWindows configuration.}
 283
 284 \docparam{palette}{An optional palette used for saving the icon.}
 285
 286 \wxheading{Return value}
 287
 288 TRUE if the operation succeeded, FALSE otherwise.
 289
 290 \wxheading{Remarks}
 291
 292 Depending on how wxWindows has been configured, not all formats may be available.
 293
 294 \wxheading{See also}
 295
 296 \helpref{wxIcon::LoadFile}{wxiconloadfile}
 297 \end{comment}
 298
 299 \membersection{wxIcon::SetDepth}\label{wxiconsetdepth}
 300
 301 \func{void}{SetDepth}{\param{int }{depth}}
 302
 303 Sets the depth member (does not affect the icon data).
 304
 305 \wxheading{Parameters}
 306
 307 \docparam{depth}{Icon depth.}
 308
 309 \membersection{wxIcon::SetHeight}\label{wxiconsetheight}
 310
 311 \func{void}{SetHeight}{\param{int }{height}}
 312
 313 Sets the height member (does not affect the icon data).
 314
 315 \wxheading{Parameters}
 316
 317 \docparam{height}{Icon height in pixels.}
 318
 319 \membersection{wxIcon::SetOk}
 320
 321 \func{void}{SetOk}{\param{int }{isOk}}
 322
 323 Sets the validity member (does not affect the icon data).
 324
 325 \wxheading{Parameters}
 326
 327 \docparam{isOk}{Validity flag.}
 328
 329 \membersection{wxIcon::SetWidth}
 330
 331 \func{void}{SetWidth}{\param{int }{width}}
 332
 333 Sets the width member (does not affect the icon data).
 334
 335 \wxheading{Parameters}
 336
 337 \docparam{width}{Icon width in pixels.}
 338
 339 \membersection{wxIcon::operator $=$}
 340
 341 \func{wxIcon\& }{operator $=$}{\param{const wxIcon\& }{icon}}
 342
 343 Assignment operator. This operator does not copy any data, but instead
 344 passes a pointer to the data in {\it icon} and increments a reference
 345 counter. It is a fast operation.
 346
 347 \wxheading{Parameters}
 348
 349 \docparam{icon}{Icon to assign.}
 350
 351 \wxheading{Return value}
 352
 353 Returns 'this' object.
 354
 355 \membersection{wxIcon::operator $==$}
 356
 357 \func{bool}{operator $==$}{\param{const wxIcon\& }{icon}}
 358
 359 Equality operator. This operator tests whether the internal data pointers are
 360 equal (a fast test).
 361
 362 \wxheading{Parameters}
 363
 364 \docparam{icon}{Icon to compare with 'this'}
 365
 366 \wxheading{Return value}
 367
 368 Returns TRUE if the icons were effectively equal, FALSE otherwise.
 369
 370 \membersection{wxIcon::operator $!=$}
 371
 372 \func{bool}{operator $!=$}{\param{const wxIcon\& }{icon}}
 373
 374 Inequality operator. This operator tests whether the internal data pointers are
 375 unequal (a fast test).
 376
 377 \wxheading{Parameters}
 378
 379 \docparam{icon}{Icon to compare with 'this'}
 380
 381 \wxheading{Return value}
 382
 383 Returns TRUE if the icons were unequal, FALSE otherwise.
 384
 385