docs/latex/wx/image.tex

   1 \section{\class{wxImage}}\label{wximage}
   2
   3 This class encapsulates a platform-independent image. An image can be created
   4 from data, or using \helpref{wxBitmap::ConvertToImage}{wxbitmapconverttoimage}. An image
   5 can be loaded from a file in a variety of formats, and is extensible to new formats
   6 via image format handlers. Functions are available to set and get image bits, so
   7 it can be used for basic image manipulation.
   8
   9 A wxImage cannot (currently) be drawn directly to a \helpref{wxDC}{wxdc}. Instead,
  10 a platform-specific \helpref{wxBitmap}{wxbitmap} object must be created from it using
  11 the \helpref{wxBitmap::wxBitmap(wxImage,int depth)}{wxbitmapconstr} constructor.
  12 This bitmap can then
  13 be drawn in a device context, using \helpref{wxDC::DrawBitmap}{wxdcdrawbitmap}.
  14
  15 One colour value of the image may be used as a mask colour which will lead to the automatic
  16 creation of a \helpref{wxMask}{wxmask} object associated to the bitmap object.
  17
  18 \wxheading{Alpha channel support}
  19
  20 Starting from wxWidgets 2.5.0 wxImage supports alpha channel data, that is in
  21 addition to a byte for the red, green and blue colour components for each pixel
  22 it also stores a byte representing the pixel opacity. The alpha value of $0$
  23 corresponds to a transparent pixel (null opacity) while the value of $255$
  24 means that the pixel is 100\% opaque.
  25
  26 Unlike the RGB data, not all images have the alpha channel and before using
  27 \helpref{GetAlpha}{wximagegetalpha} you should check if this image contains
  28 alpha value with \helpref{HasAlpha}{wximagehasalpha}. In fact, currently only
  29 images loaded from PNG files with transparency information will have alpha
  30 channel but support for it will be added to the other formats as well (as well
  31 as support for saving images with alpha channel which is not still implemented
  32 either).
  33
  34 \wxheading{Available image handlers}
  35
  36 The following image handlers are available. {\bf wxBMPHandler} is always
  37 installed by default. To use other image formats, install the appropriate
  38 handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or
  39 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}.
  40
  41 \twocolwidtha{5cm}%
  42 \begin{twocollist}
  43 \twocolitem{\indexit{wxBMPHandler}}{For loading and saving, always installed.}
  44 \twocolitem{\indexit{wxPNGHandler}}{For loading (including alpha support) and saving.}
  45 \twocolitem{\indexit{wxJPEGHandler}}{For loading and saving.}
  46 \twocolitem{\indexit{wxGIFHandler}}{Only for loading, due to legal issues.}
  47 \twocolitem{\indexit{wxPCXHandler}}{For loading and saving (see below).}
  48 \twocolitem{\indexit{wxPNMHandler}}{For loading and saving (see below).}
  49 \twocolitem{\indexit{wxTIFFHandler}}{For loading and saving.}
  50 \twocolitem{\indexit{wxIFFHandler}}{For loading only.}
  51 \twocolitem{\indexit{wxXPMHandler}}{For loading and saving.}
  52 \twocolitem{\indexit{wxICOHandler}}{For loading and saving.}
  53 \twocolitem{\indexit{wxCURHandler}}{For loading and saving.}
  54 \twocolitem{\indexit{wxANIHandler}}{For loading only.}
  55 \end{twocollist}
  56
  57 When saving in PCX format, {\bf wxPCXHandler} will count the number of
  58 different colours in the image; if there are 256 or less colours, it will
  59 save as 8 bit, else it will save as 24 bit.
  60
  61 Loading PNMs only works for ASCII or raw RGB images. When saving in
  62 PNM format, {\bf wxPNMHandler} will always save as raw RGB.
  63
  64 \wxheading{Derived from}
  65
  66 \helpref{wxObject}{wxobject}
  67
  68 \wxheading{Include files}
  69
  70 <wx/image.h>
  71
  72 \wxheading{See also}
  73
  74 \helpref{wxBitmap}{wxbitmap},
  75 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
  76
  77 \latexignore{\rtfignore{\wxheading{Members}}}
  78
  79 \membersection{wxImage::wxImage}\label{wximageconstr}
  80
  81 \func{}{wxImage}{\void}
  82
  83 Default constructor.
  84
  85 \func{}{wxImage}{\param{const wxImage\& }{image}}
  86
  87 Copy constructor.
  88
  89 \func{}{wxImage}{\param{const wxBitmap\&}{ bitmap}}
  90
  91 (Deprecated form, use \helpref{wxBitmap::ConvertToImage}{wxbitmapconverttoimage}
  92 instead.) Constructs an image from a platform-dependent bitmap. This preserves
  93 mask information so that bitmaps and images can be converted back
  94 and forth without loss in that respect.
  95
  96 \func{}{wxImage}{\param{int}{ width}, \param{int}{ height}, \param{bool}{ clear=true}}
  97
  98 Creates an image with the given width and height.  If {\it clear} is true, the new image will be initialized to black.
  99 Otherwise, the image data will be uninitialized.
 100
 101 \func{}{wxImage}{\param{int}{ width}, \param{int}{ height}, \param{unsigned char*}{ data}, \param{bool}{ static\_data=false}}
 102
 103 Creates an image from given data with the given width and height. If
 104 {\it static\_data} is true, then wxImage will not delete the actual
 105 image data in its destructor, otherwise it will free it by calling
 106 {\it free()}.
 107
 108 \func{}{wxImage}{\param{const wxString\& }{name}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}, \param{int}{ index = -1}}
 109
 110 \func{}{wxImage}{\param{const wxString\& }{name}, \param{const wxString\&}{ mimetype}, \param{int}{ index = -1}}
 111
 112 Loads an image from a file.
 113
 114 \func{}{wxImage}{\param{wxInputStream\& }{stream}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}, \param{int}{ index = -1}}
 115
 116 \func{}{wxImage}{\param{wxInputStream\& }{stream}, \param{const wxString\&}{ mimetype}, \param{int}{ index = -1}}
 117
 118 Loads an image from an input stream.
 119
 120 \wxheading{Parameters}
 121
 122 \docparam{width}{Specifies the width of the image.}
 123
 124 \docparam{height}{Specifies the height of the image.}
 125
 126 \docparam{name}{Name of the file from which to load the image.}
 127
 128 \docparam{stream}{Opened input stream from which to load the image. Currently, the stream must support seeking.}
 129
 130 \docparam{type}{May be one of the following:
 131
 132 \twocolwidtha{5cm}%
 133 \begin{twocollist}
 134 \twocolitem{\indexit{wxBITMAP\_TYPE\_BMP}}{Load a Windows bitmap file.}
 135 \twocolitem{\indexit{wxBITMAP\_TYPE\_GIF}}{Load a GIF bitmap file.}
 136 \twocolitem{\indexit{wxBITMAP\_TYPE\_JPEG}}{Load a JPEG bitmap file.}
 137 \twocolitem{\indexit{wxBITMAP\_TYPE\_PNG}}{Load a PNG bitmap file.}
 138 \twocolitem{\indexit{wxBITMAP\_TYPE\_PCX}}{Load a PCX bitmap file.}
 139 \twocolitem{\indexit{wxBITMAP\_TYPE\_PNM}}{Load a PNM bitmap file.}
 140 \twocolitem{\indexit{wxBITMAP\_TYPE\_TIF}}{Load a TIFF bitmap file.}
 141 \twocolitem{\indexit{wxBITMAP\_TYPE\_XPM}}{Load a XPM bitmap file.}
 142 \twocolitem{\indexit{wxBITMAP\_TYPE\_ICO}}{Load a Windows icon file (ICO).}
 143 \twocolitem{\indexit{wxBITMAP\_TYPE\_CUR}}{Load a Windows cursor file (CUR).}
 144 \twocolitem{\indexit{wxBITMAP\_TYPE\_ANI}}{Load a Windows animated cursor file (ANI).}
 145 \twocolitem{\indexit{wxBITMAP\_TYPE\_ANY}}{Will try to autodetect the format.}
 146 \end{twocollist}}
 147
 148 \docparam{mimetype}{MIME type string (for example 'image/jpeg')}
 149
 150 \docparam{index}{Index of the image to load in the case that the image file contains multiple images.
 151 This is only used by GIF, ICO and TIFF handlers. The default value (-1) means
 152 "choose the default image" and is interpreted as the first image (index=0) by
 153 the GIF and TIFF handler and as the largest and most colourful one by the ICO handler.}
 154
 155 \wxheading{Remarks}
 156
 157 Depending on how wxWidgets has been configured, not all formats may be available.
 158
 159 Note: any handler other than BMP must be previously
 160 initialized with \helpref{wxImage::AddHandler}{wximageaddhandler} or
 161 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}.
 162
 163 Note: you can use \helpref{GetOptionInt}{wximagegetoptionint} to get the
 164 hotspot for loaded cursor file:
 165 \begin{verbatim}
 166     int hotspot_x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
 167     int hotspot_y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
 168
 169 \end{verbatim}
 170
 171 \wxheading{See also}
 172
 173 \helpref{wxImage::LoadFile}{wximageloadfile}
 174
 175 \pythonnote{Constructors supported by wxPython are:\par
 176 \indented{2cm}{\begin{twocollist}
 177 \twocolitem{{\bf wxImage(name, flag)}}{Loads an image from a file}
 178 \twocolitem{{\bf wxNullImage()}}{Create a null image (has no size or
 179 image data)}
 180 \twocolitem{{\bf wxEmptyImage(width, height)}}{Creates an empty image
 181 of the given size}
 182 \twocolitem{{\bf wxImageFromMime(name, mimetype}}{Creates an image from
 183 the given file of the given mimetype}
 184 \twocolitem{{\bf wxImageFromBitmap(bitmap)}}{Creates an image from a
 185 platform-dependent bitmap}
 186 \end{twocollist}}
 187 }
 188
 189 \perlnote{Constructors supported by wxPerl are:\par
 190 \begin{itemize}
 191 \item{Wx::Image->new( bitmap )}
 192 \item{Wx::Image->new( icon )}
 193 \item{Wx::Image->new( width, height )}
 194 \item{Wx::Image->new( width, height, data )}
 195 \item{Wx::Image->new( file, type, index )}
 196 \item{Wx::Image->new( file, mimetype, index )}
 197 \item{Wx::Image->new( stream, type, index )}
 198 \item{Wx::Image->new( stream, mimetype, index )}
 199 \end{itemize}
 200 }
 201
 202 \membersection{wxImage::\destruct{wxImage}}
 203
 204 \func{}{\destruct{wxImage}}{\void}
 205
 206 Destructor.
 207
 208 \membersection{wxImage::AddHandler}\label{wximageaddhandler}
 209
 210 \func{static void}{AddHandler}{\param{wxImageHandler*}{ handler}}
 211
 212 Adds a handler to the end of the static list of format handlers.
 213
 214 \docparam{handler}{A new image format handler object. There is usually only one instance
 215 of a given handler class in an application session.}
 216
 217 \wxheading{See also}
 218
 219 \helpref{wxImageHandler}{wximagehandler}
 220
 221 \func{bool}{CanRead}{\param{const wxString\&}{ filename}}
 222
 223 returns true if the current image handlers can read this file
 224
 225 \pythonnote{In wxPython this static method is named {\tt wxImage\_AddHandler}.}
 226 \membersection{wxImage::CleanUpHandlers}
 227
 228 \func{static void}{CleanUpHandlers}{\void}
 229
 230 Deletes all image handlers.
 231
 232 This function is called by wxWidgets on exit.
 233
 234 \membersection{wxImage::ComputeHistogram}\label{wximagecomputehistogram}
 235
 236 \constfunc{unsigned long}{ComputeHistogram}{\param{wxImageHistogram\& }{histogram}}
 237
 238 Computes the histogram of the image. {\it histogram} is a reference to
 239 wxImageHistogram object. wxImageHistogram is a specialization of
 240 \helpref{wxHashMap}{wxhashmap} "template" and is defined as follows:
 241
 242 \begin{verbatim}
 243 class WXDLLEXPORT wxImageHistogramEntry
 244 {
 245 public:
 246     wxImageHistogramEntry() : index(0), value(0) {}
 247     unsigned long index;
 248     unsigned long value;
 249 };
 250
 251 WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry,
 252                              wxIntegerHash, wxIntegerEqual,
 253                              wxImageHistogram);
 254 \end{verbatim}
 255
 256 \wxheading{Return value}
 257
 258 Returns number of colours in the histogram.
 259
 260 \membersection{wxImage::ConvertAlphaToMask}\label{wximageconvertalphatomask}
 261
 262 \func{bool}{ConvertAlphaToMask}{\param{unsigned char}{ threshold = 128}}
 263
 264 If the image has alpha channel, this method converts it to mask. All pixels
 265 with alpha value less than \arg{threshold} are replaced with mask colour
 266 and the alpha channel is removed. Mask colour is chosen automatically using
 267 \helpref{FindFirstUnusedColour}{wximagefindfirstunusedcolour}.
 268
 269 If the image image doesn't have alpha channel,
 270 ConvertAlphaToMask does nothing.
 271
 272 \wxheading{Return value}
 273
 274 \false if FindFirstUnusedColour returns \false, \true otherwise.
 275
 276 \membersection{wxImage::ConvertToBitmap}\label{wximageconverttobitmap}
 277
 278 \constfunc{wxBitmap}{ConvertToBitmap}{\void}
 279
 280 Deprecated, use equivalent \helpref{wxBitmap constructor}{wxbitmapconstr}
 281 (which takes wxImage and depth as its arguments) instead.
 282
 283 \membersection{wxImage::ConvertToMono}\label{wxbitmapconverttomono}
 284
 285 \constfunc{wxImage}{ConvertToMono}{\param{unsigned char}{ r}, \param{unsigned char}{ g}, \param{unsigned char}{ b}}
 286
 287 Returns monochromatic version of the image. The returned image has white
 288 colour where the original has {\it (r,g,b)} colour and black colour
 289 everywhere else.
 290
 291 \membersection{wxImage::Copy}\label{wximagecopy}
 292
 293 \constfunc{wxImage}{Copy}{\void}
 294
 295 Returns an identical copy of the image.
 296
 297 \membersection{wxImage::Create}\label{wximagecreate}
 298
 299 \func{bool}{Create}{\param{int}{ width}, \param{int}{ height}, \param{bool}{ clear=true}}
 300
 301 Creates a fresh image.  If {\it clear} is true, the new image will be initialized to black.
 302 Otherwise, the image data will be uninitialized.
 303
 304 \wxheading{Parameters}
 305
 306 \docparam{width}{The width of the image in pixels.}
 307
 308 \docparam{height}{The height of the image in pixels.}
 309
 310 \wxheading{Return value}
 311
 312 true if the call succeeded, false otherwise.
 313
 314 \membersection{wxImage::Destroy}\label{wximagedestroy}
 315
 316 \func{bool}{Destroy}{\void}
 317
 318 Destroys the image data.
 319
 320 \membersection{wxImage::FindFirstUnusedColour}\label{wximagefindfirstunusedcolour}
 321
 322 \func{bool}{FindFirstUnusedColour}{\param{unsigned char *}{ r}, \param{unsigned char *}{ g}, \param{unsigned char *}{ b}, \param{unsigned char}{ startR = 1}, \param{unsigned char}{ startG = 0}, \param{unsigned char}{ startB = 0}}
 323
 324 \wxheading{Parameters}
 325
 326 \docparam{r,g,b}{Pointers to variables to save the colour.}
 327
 328 \docparam{startR,startG,startB}{Initial values of the colour. Returned colour
 329 will have RGB values equal to or greater than these.}
 330
 331 Finds the first colour that is never used in the image. The search begins at
 332 given initial colour and continues by increasing R, G and B components (in this
 333 order) by 1 until an unused colour is found or the colour space exhausted.
 334
 335 \wxheading{Return value}
 336
 337 Returns false if there is no unused colour left, true on success.
 338
 339 \wxheading{Notes}
 340
 341 Note that this method involves computing the histogram, which is
 342 computationally intensive operation.
 343
 344 \membersection{wxImage::FindHandler}
 345
 346 \func{static wxImageHandler*}{FindHandler}{\param{const wxString\& }{name}}
 347
 348 Finds the handler with the given name.
 349
 350 \func{static wxImageHandler*}{FindHandler}{\param{const wxString\& }{extension}, \param{long}{ imageType}}
 351
 352 Finds the handler associated with the given extension and type.
 353
 354 \func{static wxImageHandler*}{FindHandler}{\param{long }{imageType}}
 355
 356 Finds the handler associated with the given image type.
 357
 358 \func{static wxImageHandler*}{FindHandlerMime}{\param{const wxString\& }{mimetype}}
 359
 360 Finds the handler associated with the given MIME type.
 361
 362 \docparam{name}{The handler name.}
 363
 364 \docparam{extension}{The file extension, such as ``bmp".}
 365
 366 \docparam{imageType}{The image type, such as wxBITMAP\_TYPE\_BMP.}
 367
 368 \docparam{mimetype}{MIME type.}
 369
 370 \wxheading{Return value}
 371
 372 A pointer to the handler if found, NULL otherwise.
 373
 374 \wxheading{See also}
 375
 376 \helpref{wxImageHandler}{wximagehandler}
 377
 378 \membersection{wxImage::GetImageExtWildcard}
 379
 380 \func{static wxString}{GetImageExtWildcard}{\void}
 381
 382 Iterates all registered wxImageHandler objects, and returns a string containing file extension masks
 383 suitable for passing to file open/save dialog boxes.
 384
 385 \wxheading{Return value}
 386
 387 The format of the returned string is "(*.ext1;*.ext2)|*.ext1;*.ext2".
 388
 389 It is usually a good idea to prepend a description before passing the result to the dialog.
 390
 391 Example:
 392
 393 \begin{verbatim}
 394     wxFileDialog FileDlg( this, "Choose Image", ::wxGetWorkingDirectory(), "", _("Image Files ") + wxImage::GetImageExtWildcard(), wxOPEN );
 395 \end{verbatim}
 396
 397 \wxheading{See also}
 398
 399 \helpref{wxImageHandler}{wximagehandler}
 400
 401 \membersection{wxImage::GetAlpha}\label{wximagegetalpha}
 402
 403 \constfunc{unsigned char}{GetAlpha}{\param{int}{ x}, \param{int}{ y}}
 404
 405 Returns the alpha value for the given pixel. This function may only be called
 406 for the images with alpha channel, use \helpref{HasAlpha}{wximagehasalpha} to
 407 check for this.
 408
 409 The returned value is the {\it opacity} of the image, i.e. the value of $0$
 410 corresponds to the transparent pixels while the value of $255$ -- to the opaque
 411 ones.
 412
 413 \constfunc{unsigned char *}{GetAlpha}{\void}
 414
 415 Returns pointer to the array storing the alpha values for this image. This
 416 pointer is {\tt NULL} for the images without the alpha channel. If the image
 417 does have it, this pointer may be used to directly manipulate the alpha values
 418 which are stored as the \helpref{RGB}{wximagegetdata} ones.
 419
 420 \membersection{wxImage::GetBlue}\label{wximagegetblue}
 421
 422 \constfunc{unsigned char}{GetBlue}{\param{int}{ x}, \param{int}{ y}}
 423
 424 Returns the blue intensity at the given coordinate.
 425
 426 \membersection{wxImage::GetData}\label{wximagegetdata}
 427
 428 \constfunc{unsigned char*}{GetData}{\void}
 429
 430 Returns the image data as an array. This is most often used when doing
 431 direct image manipulation. The return value points to an array of
 432 characters in RGBRGBRGB$\ldots$ format in the top-to-bottom, left-to-right
 433 order, that is the first RGB triplet corresponds to the pixel $(0, 0)$, the
 434 second one --- to $(0, 1)$ and so on.
 435
 436 You should not delete the returned pointer nor pass it to
 437 \helpref{wxImage::SetData}{wximagesetdata}.
 438
 439 \membersection{wxImage::GetGreen}\label{wximagegetgreen}
 440
 441 \constfunc{unsigned char}{GetGreen}{\param{int}{ x}, \param{int}{ y}}
 442
 443 Returns the green intensity at the given coordinate.
 444
 445 \membersection{wxImage::GetImageCount}\label{wximagegetimagecount}
 446
 447 \func{static int}{GetImageCount}{\param{const wxString\&}{ filename}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}}
 448
 449 \func{static int}{GetImageCount}{\param{wxInputStream\&}{ stream}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}}
 450
 451 If the image file contains more than one image and the image handler is capable
 452 of retrieving these individually, this function will return the number of
 453 available images.
 454
 455 \docparam{name}{Name of the file to query.}
 456
 457 \docparam{stream}{Opened input stream with image data. Currently, the stream must support seeking.}
 458
 459 \docparam{type}{May be one of the following:
 460
 461 \twocolwidtha{5cm}%
 462 \begin{twocollist}
 463 \twocolitem{\indexit{wxBITMAP\_TYPE\_BMP}}{Load a Windows bitmap file.}
 464 \twocolitem{\indexit{wxBITMAP\_TYPE\_GIF}}{Load a GIF bitmap file.}
 465 \twocolitem{\indexit{wxBITMAP\_TYPE\_JPEG}}{Load a JPEG bitmap file.}
 466 \twocolitem{\indexit{wxBITMAP\_TYPE\_PNG}}{Load a PNG bitmap file.}
 467 \twocolitem{\indexit{wxBITMAP\_TYPE\_PCX}}{Load a PCX bitmap file.}
 468 \twocolitem{\indexit{wxBITMAP\_TYPE\_PNM}}{Load a PNM bitmap file.}
 469 \twocolitem{\indexit{wxBITMAP\_TYPE\_TIF}}{Load a TIFF bitmap file.}
 470 \twocolitem{\indexit{wxBITMAP\_TYPE\_XPM}}{Load a XPM bitmap file.}
 471 \twocolitem{\indexit{wxBITMAP\_TYPE\_ICO}}{Load a Windows icon file (ICO).}
 472 \twocolitem{\indexit{wxBITMAP\_TYPE\_CUR}}{Load a Windows cursor file (CUR).}
 473 \twocolitem{\indexit{wxBITMAP\_TYPE\_ANI}}{Load a Windows animated cursor file (ANI).}
 474 \twocolitem{\indexit{wxBITMAP\_TYPE\_ANY}}{Will try to autodetect the format.}
 475 \end{twocollist}}
 476
 477 \wxheading{Return value}
 478
 479 Number of available images. For most image handlers, this is 1 (exceptions
 480 are TIFF and ICO formats).
 481
 482 \membersection{wxImage::GetHandlers}
 483
 484 \func{static wxList\&}{GetHandlers}{\void}
 485
 486 Returns the static list of image format handlers.
 487
 488 \wxheading{See also}
 489
 490 \helpref{wxImageHandler}{wximagehandler}
 491
 492 \membersection{wxImage::GetHeight}\label{wximagegetheight}
 493
 494 \constfunc{int}{GetHeight}{\void}
 495
 496 Gets the height of the image in pixels.
 497
 498 \membersection{wxImage::GetMaskBlue}\label{wximagegetmaskblue}
 499
 500 \constfunc{unsigned char}{GetMaskBlue}{\void}
 501
 502 Gets the blue value of the mask colour.
 503
 504 \membersection{wxImage::GetMaskGreen}\label{wximagegetmaskgreen}
 505
 506 \constfunc{unsigned char}{GetMaskGreen}{\void}
 507
 508 Gets the green value of the mask colour.
 509
 510 \membersection{wxImage::GetMaskRed}\label{wximagegetmaskred}
 511
 512 \constfunc{unsigned char}{GetMaskRed}{\void}
 513
 514 Gets the red value of the mask colour.
 515
 516 \membersection{wxImage::GetPalette}\label{wximagegetpalette}
 517
 518 \constfunc{const wxPalette\&}{GetPalette}{\void}
 519
 520 Returns the palette associated with the image. Currently the palette is only
 521 used when converting to wxBitmap under Windows.
 522
 523 Eventually wxImage handlers will set the palette if one exists in the image file.
 524
 525 \membersection{wxImage::GetRed}\label{wximagegetred}
 526
 527 \constfunc{unsigned char}{GetRed}{\param{int}{ x}, \param{int}{ y}}
 528
 529 Returns the red intensity at the given coordinate.
 530
 531 \membersection{wxImage::GetSubImage}\label{wximagegetsubimage}
 532
 533 \constfunc{wxImage}{GetSubImage}{\param{const wxRect\&}{ rect}}
 534
 535 Returns a sub image of the current one as long as the rect belongs entirely to
 536 the image.
 537
 538 \membersection{wxImage::GetWidth}\label{wximagegetwidth}
 539
 540 \constfunc{int}{GetWidth}{\void}
 541
 542 Gets the width of the image in pixels.
 543
 544 \wxheading{See also}
 545
 546 \helpref{wxImage::GetHeight}{wximagegetheight}
 547
 548 \membersection{wxImage::HasAlpha}\label{wximagehasalpha}
 549
 550 \constfunc{bool}{HasAlpha}{\void}
 551
 552 Returns true if this image has alpha channel, false otherwise.
 553
 554 \wxheading{See also}
 555
 556 \helpref{GetAlpha}{wximagegetalpha}, \helpref{SetAlpha}{wximagesetalpha}
 557
 558 \membersection{wxImage::HasMask}\label{wximagehasmask}
 559
 560 \constfunc{bool}{HasMask}{\void}
 561
 562 Returns true if there is a mask active, false otherwise.
 563
 564 \membersection{wxImage::GetOption}\label{wximagegetoption}
 565
 566 \constfunc{wxString}{GetOption}{\param{const wxString\&}{ name}}
 567
 568 Gets a user-defined option. The function is case-insensitive to {\it name}.
 569
 570 For example, when saving as a JPEG file, the option {\bf quality} is
 571 used, which is a number between 0 and 100 (0 is terrible, 100 is very good).
 572
 573 \wxheading{See also}
 574
 575 \helpref{wxImage::SetOption}{wximagesetoption},\rtfsp
 576 \helpref{wxImage::GetOptionInt}{wximagegetoptionint},\rtfsp
 577 \helpref{wxImage::HasOption}{wximagehasoption}
 578
 579 \membersection{wxImage::GetOptionInt}\label{wximagegetoptionint}
 580
 581 \constfunc{int}{GetOptionInt}{\param{const wxString\&}{ name}}
 582
 583 Gets a user-defined option as an integer. The function is case-insensitive to {\it name}.
 584
 585 \wxheading{See also}
 586
 587 \helpref{wxImage::SetOption}{wximagesetoption},\rtfsp
 588 \helpref{wxImage::GetOption}{wximagegetoption},\rtfsp
 589 \helpref{wxImage::HasOption}{wximagehasoption}
 590
 591 \membersection{wxImage::HasOption}\label{wximagehasoption}
 592
 593 \constfunc{bool}{HasOption}{\param{const wxString\&}{ name}}
 594
 595 Returns true if the given option is present. The function is case-insensitive to {\it name}.
 596
 597 \wxheading{See also}
 598
 599 \helpref{wxImage::SetOption}{wximagesetoption},\rtfsp
 600 \helpref{wxImage::GetOption}{wximagegetoption},\rtfsp
 601 \helpref{wxImage::GetOptionInt}{wximagegetoptionint}
 602
 603 \membersection{wxImage::InitStandardHandlers}
 604
 605 \func{static void}{InitStandardHandlers}{\void}
 606
 607 Internal use only. Adds standard image format handlers. It only install BMP
 608 for the time being, which is used by wxBitmap.
 609
 610 This function is called by wxWidgets on startup, and shouldn't be called by
 611 the user.
 612
 613 \wxheading{See also}
 614
 615 \helpref{wxImageHandler}{wximagehandler},
 616 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
 617
 618 \membersection{wxImage::InsertHandler}
 619
 620 \func{static void}{InsertHandler}{\param{wxImageHandler*}{ handler}}
 621
 622 Adds a handler at the start of the static list of format handlers.
 623
 624 \docparam{handler}{A new image format handler object. There is usually only one instance
 625 of a given handler class in an application session.}
 626
 627 \wxheading{See also}
 628
 629 \helpref{wxImageHandler}{wximagehandler}
 630
 631 \membersection{wxImage::LoadFile}\label{wximageloadfile}
 632
 633 \func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}, \param{int}{ index = -1}}
 634
 635 \func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{const wxString\&}{ mimetype}, \param{int}{ index = -1}}
 636
 637 Loads an image from a file. If no handler type is provided, the library will
 638 try to autodetect the format.
 639
 640 \func{bool}{LoadFile}{\param{wxInputStream\&}{ stream}, \param{long}{ type}, \param{int}{ index = -1}}
 641
 642 \func{bool}{LoadFile}{\param{wxInputStream\&}{ stream}, \param{const wxString\&}{ mimetype}, \param{int}{ index = -1}}
 643
 644 Loads an image from an input stream.
 645
 646 \wxheading{Parameters}
 647
 648 \docparam{name}{Name of the file from which to load the image.}
 649
 650 \docparam{stream}{Opened input stream from which to load the image. Currently, the stream must support seeking.}
 651
 652 \docparam{type}{One of the following values:
 653
 654 \twocolwidtha{5cm}%
 655 \begin{twocollist}
 656 \twocolitem{{\bf wxBITMAP\_TYPE\_BMP}}{Load a Windows image file.}
 657 \twocolitem{{\bf wxBITMAP\_TYPE\_GIF}}{Load a GIF image file.}
 658 \twocolitem{{\bf wxBITMAP\_TYPE\_JPEG}}{Load a JPEG image file.}
 659 \twocolitem{{\bf wxBITMAP\_TYPE\_PCX}}{Load a PCX image file.}
 660 \twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Load a PNG image file.}
 661 \twocolitem{{\bf wxBITMAP\_TYPE\_PNM}}{Load a PNM image file.}
 662 \twocolitem{{\bf wxBITMAP\_TYPE\_TIF}}{Load a TIFF image file.}
 663 \twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Load a XPM image file.}
 664 \twocolitem{{\bf wxBITMAP\_TYPE\_ICO}}{Load a Windows icon file (ICO).}
 665 \twocolitem{{\bf wxBITMAP\_TYPE\_CUR}}{Load a Windows cursor file (CUR).}
 666 \twocolitem{\indexit{wxBITMAP\_TYPE\_ANI}}{Load a Windows animated cursor file (ANI).}
 667 \twocolitem{{\bf wxBITMAP\_TYPE\_ANY}}{Will try to autodetect the format.}
 668 \end{twocollist}}
 669
 670 \docparam{mimetype}{MIME type string (for example 'image/jpeg')}
 671
 672 \docparam{index}{Index of the image to load in the case that the image file contains multiple images.
 673 This is only used by GIF, ICO and TIFF handlers. The default value (-1) means
 674 "choose the default image" and is interpreted as the first image (index=0) by
 675 the GIF and TIFF handler and as the largest and most colourful one by the ICO handler.}
 676
 677 \wxheading{Remarks}
 678
 679 Depending on how wxWidgets has been configured, not all formats may be available.
 680
 681 Note: you can use \helpref{GetOptionInt}{wximagegetoptionint} to get the
 682 hotspot for loaded cursor file:
 683 \begin{verbatim}
 684     int hotspot_x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
 685     int hotspot_y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
 686
 687 \end{verbatim}
 688
 689 \wxheading{Return value}
 690
 691 true if the operation succeeded, false otherwise. If the optional index parameter is out of range,
 692 false is returned and a call to wxLogError() takes place.
 693
 694 \wxheading{See also}
 695
 696 \helpref{wxImage::SaveFile}{wximagesavefile}
 697
 698 \pythonnote{In place of a single overloaded method name, wxPython
 699 implements the following methods:\par
 700 \indented{2cm}{\begin{twocollist}
 701 \twocolitem{{\bf LoadFile(filename, type)}}{Loads an image of the given
 702 type from a file}
 703 \twocolitem{{\bf LoadMimeFile(filename, mimetype)}}{Loads an image of the given
 704 mimetype from a file}
 705 \end{twocollist}}
 706 }
 707
 708 \perlnote{Methods supported by wxPerl are:\par
 709 \begin{itemize}
 710 \item{bitmap->LoadFile( name, type )}
 711 \item{bitmap->LoadFile( name, mimetype )}
 712 \end{itemize}
 713 }
 714
 715
 716 \membersection{wxImage::Ok}\label{wximageok}
 717
 718 \constfunc{bool}{Ok}{\void}
 719
 720 Returns true if image data is present.
 721
 722 \membersection{wxImage::RemoveHandler}
 723
 724 \func{static bool}{RemoveHandler}{\param{const wxString\& }{name}}
 725
 726 Finds the handler with the given name, and removes it. The handler
 727 is not deleted.
 728
 729 \docparam{name}{The handler name.}
 730
 731 \wxheading{Return value}
 732
 733 true if the handler was found and removed, false otherwise.
 734
 735 \wxheading{See also}
 736
 737 \helpref{wxImageHandler}{wximagehandler}
 738
 739 \membersection{wxImage::Mirror}\label{wximagemirror}
 740
 741 \constfunc{wxImage}{Mirror}{\param{bool}{ horizontally = true}}
 742
 743 Returns a mirrored copy of the image. The parameter {\it horizontally}
 744 indicates the orientation.
 745
 746 \membersection{wxImage::Replace}\label{wximagereplace}
 747
 748 \func{void}{Replace}{\param{unsigned char}{ r1}, \param{unsigned char}{ g1}, \param{unsigned char}{ b1},
 749 \param{unsigned char}{ r2}, \param{unsigned char}{ g2}, \param{unsigned char}{ b2}}
 750
 751 Replaces the colour specified by {\it r1,g1,b1} by the colour {\it r2,g2,b2}.
 752
 753 \membersection{wxImage::Rescale}\label{wximagerescale}
 754
 755 \func{wxImage \&}{Rescale}{\param{int}{ width}, \param{int}{ height}}
 756
 757 Changes the size of the image in-place: after a call to this function, the
 758 image will have the given width and height.
 759
 760 Returns the (modified) image itself.
 761
 762 \wxheading{See also}
 763
 764 \helpref{Scale}{wximagescale}
 765
 766 \membersection{wxImage::Rotate}\label{wximagerotate}
 767
 768 \func{wxImage}{Rotate}{\param{double}{ angle}, \param{const wxPoint\& }{rotationCentre},
 769  \param{bool}{ interpolating = true}, \param{wxPoint*}{ offsetAfterRotation = NULL}}
 770
 771 Rotates the image about the given point, by {\it angle} radians. Passing true
 772 to {\it interpolating} results in better image quality, but is slower. If the
 773 image has a mask, then the mask colour is used for the uncovered pixels in the
 774 rotated image background. Else, black (rgb 0, 0, 0) will be used.
 775
 776 Returns the rotated image, leaving this image intact.
 777
 778 \membersection{wxImage::Rotate90}\label{wximagerotate90}
 779
 780 \constfunc{wxImage}{Rotate90}{\param{bool}{ clockwise = true}}
 781
 782 Returns a copy of the image rotated 90 degrees in the direction
 783 indicated by {\it clockwise}.
 784
 785 \membersection{wxImage::SaveFile}\label{wximagesavefile}
 786
 787 \constfunc{bool}{SaveFile}{\param{const wxString\& }{name}, \param{int}{ type}}
 788
 789 \constfunc{bool}{SaveFile}{\param{const wxString\& }{name}, \param{const wxString\&}{ mimetype}}
 790
 791 Saves an image in the named file.
 792
 793 \constfunc{bool}{SaveFile}{\param{const wxString\& }{name}}
 794
 795 Saves an image in the named file. File type is determined from the extension of the
 796 file name. Note that this function may fail if the extension is not recognized! You
 797 can use one of the forms above to save images to files with non-standard extensions.
 798
 799 \constfunc{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{int}{ type}}
 800
 801 \constfunc{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{const wxString\&}{ mimetype}}
 802
 803 Saves an image in the given stream.
 804
 805 \wxheading{Parameters}
 806
 807 \docparam{name}{Name of the file to save the image to.}
 808
 809 \docparam{stream}{Opened output stream to save the image to.}
 810
 811 \docparam{type}{Currently these types can be used:
 812
 813 \twocolwidtha{5cm}%
 814 \begin{twocollist}
 815 \twocolitem{{\bf wxBITMAP\_TYPE\_BMP}}{Save a BMP image file.}
 816 \twocolitem{{\bf wxBITMAP\_TYPE\_JPEG}}{Save a JPEG image file.}
 817 \twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Save a PNG image file.}
 818 \twocolitem{{\bf wxBITMAP\_TYPE\_PCX}}{Save a PCX image file (tries to save as 8-bit if possible, falls back to 24-bit otherwise).}
 819 \twocolitem{{\bf wxBITMAP\_TYPE\_PNM}}{Save a PNM image file (as raw RGB always).}
 820 \twocolitem{{\bf wxBITMAP\_TYPE\_TIFF}}{Save a TIFF image file.}
 821 \twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Save a XPM image file.}
 822 \twocolitem{{\bf wxBITMAP\_TYPE\_ICO}}{Save a Windows icon file (ICO) (the size may be up to 255 wide by 127 high. A single image is saved in 8 colors at the size supplied).}
 823 \twocolitem{{\bf wxBITMAP\_TYPE\_CUR}}{Save a Windows cursor file (CUR).}
 824 \end{twocollist}}
 825
 826 \docparam{mimetype}{MIME type.}
 827
 828 \wxheading{Return value}
 829
 830 true if the operation succeeded, false otherwise.
 831
 832 \wxheading{Remarks}
 833
 834 Depending on how wxWidgets has been configured, not all formats may be available.
 835
 836 Note: you can use \helpref{GetOptionInt}{wximagegetoptionint} to set the
 837 hotspot before saving an image into a cursor file (default hotspot is in
 838 the centre of the image):
 839 \begin{verbatim}
 840     image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, hotspotX);
 841     image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y, hotspotY);
 842
 843 \end{verbatim}
 844
 845 \wxheading{See also}
 846
 847 \helpref{wxImage::LoadFile}{wximageloadfile}
 848
 849 \pythonnote{In place of a single overloaded method name, wxPython
 850 implements the following methods:\par
 851 \indented{2cm}{\begin{twocollist}
 852 \twocolitem{{\bf SaveFile(filename, type)}}{Saves the image using the given
 853 type to the named file}
 854 \twocolitem{{\bf SaveMimeFile(filename, mimetype)}}{Saves the image using the given
 855 mimetype to the named file}
 856 \end{twocollist}}
 857 }
 858
 859 \perlnote{Methods supported by wxPerl are:\par
 860 \begin{itemize}
 861 \item{bitmap->SaveFile( name, type )}
 862 \item{bitmap->SaveFile( name, mimetype )}
 863 \end{itemize}
 864 }
 865
 866 \membersection{wxImage::Scale}\label{wximagescale}
 867
 868 \constfunc{wxImage}{Scale}{\param{int}{ width}, \param{int}{ height}}
 869
 870 Returns a scaled version of the image. This is also useful for
 871 scaling bitmaps in general as the only other way to scale bitmaps
 872 is to blit a wxMemoryDC into another wxMemoryDC.
 873
 874 It may be mentioned that the GTK port uses this function internally
 875 to scale bitmaps when using mapping modes in wxDC.
 876
 877 Example:
 878
 879 \begin{verbatim}
 880     // get the bitmap from somewhere
 881     wxBitmap bmp = ...;
 882
 883     // rescale it to have size of 32*32
 884     if ( bmp.GetWidth() != 32 || bmp.GetHeight() != 32 )
 885     {
 886         wxImage image = bmp.ConvertToImage();
 887         bmp = wxBitmap(image.Scale(32, 32));
 888
 889         // another possibility:
 890         image.Rescale(32, 32);
 891         bmp = image;
 892     }
 893
 894 \end{verbatim}
 895
 896 \wxheading{See also}
 897
 898 \helpref{Rescale}{wximagerescale}
 899
 900 \membersection{wxImage::SetAlpha}\label{wximagesetalpha}
 901
 902 \func{void}{SetAlpha}{\param{unsigned char *}{alpha = {\tt NULL}}}
 903
 904 This function is similar to \helpref{SetData}{wximagesetdata} and has similar
 905 restrictions. The pointer passed to it may however be {\tt NULL} in which case
 906 the function will allocate the alpha array internally -- this is useful to add
 907 alpha channel data to an image which doesn't have any. If the pointer is not
 908 {\tt NULL}, it must have one byte for each image pixel and be allocated with
 909 {\tt malloc()}. wxImage takes ownership of the pointer and will free it.
 910
 911 \func{void}{SetAlpha}{\param{int }{x}, \param{int }{y}, \param{unsigned char }{alpha}}
 912
 913 Sets the alpha value for the given pixel. This function should only be called
 914 if the image has alpha channel data, use \helpref{HasAlpha}{wximagehasalpha} to
 915 check for this.
 916
 917 \membersection{wxImage::SetData}\label{wximagesetdata}
 918
 919 \func{void}{SetData}{\param{unsigned char*}{data}}
 920
 921 Sets the image data without performing checks. The data given must have
 922 the size (width*height*3) or results will be unexpected. Don't use this
 923 method if you aren't sure you know what you are doing.
 924
 925 The data must have been allocated with {\tt malloc()}, {\large {\bf NOT}} with
 926 {\tt operator new}.
 927
 928 After this call the pointer to the data is owned by the wxImage object,
 929 that will be responsible for deleting it.
 930 Do not pass to this function a pointer obtained through
 931 \helpref{wxImage::GetData}{wximagegetdata}.
 932
 933 \membersection{wxImage::SetMask}\label{wximagesetmask}
 934
 935 \func{void}{SetMask}{\param{bool}{ hasMask = true}}
 936
 937 Specifies whether there is a mask or not. The area of the mask is determined by the current mask colour.
 938
 939 \membersection{wxImage::SetMaskColour}\label{wximagesetmaskcolour}
 940
 941 \func{void}{SetMaskColour}{\param{unsigned char }{red}, \param{unsigned char }{green}, \param{unsigned char }{blue}}
 942
 943 Sets the mask colour for this image (and tells the image to use the mask).
 944
 945 \membersection{wxImage::SetMaskFromImage}\label{wximagesetmaskfromimage}
 946
 947 \func{bool}{SetMaskFromImage}{\param{const wxImage\&}{ mask}, \param{unsigned char}{ mr}, \param{unsigned char}{ mg}, \param{unsigned char}{ mb}}
 948
 949 \wxheading{Parameters}
 950
 951 \docparam{mask}{The mask image to extract mask shape from. Must have same dimensions as the image.}
 952
 953 \docparam{mr,mg,mb}{RGB value of pixels in {\it mask} that will be used to create the mask.}
 954
 955 Sets image's mask so that the pixels that have RGB value of {\it mr,mg,mb}
 956 in {\it mask} will be masked in the image. This is done by first finding an
 957 unused colour in the image, setting this colour as the mask colour and then
 958 using this colour to draw all pixels in the image who corresponding pixel
 959 in {\it mask} has given RGB value.
 960
 961 \wxheading{Return value}
 962
 963 Returns false if {\it mask} does not have same dimensions as the image or if
 964 there is no unused colour left. Returns true if the mask was successfully
 965 applied.
 966
 967 \wxheading{Notes}
 968
 969 Note that this method involves computing the histogram, which is
 970 computationally intensive operation.
 971
 972 \membersection{wxImage::SetOption}\label{wximagesetoption}
 973
 974 \func{void}{SetOption}{\param{const wxString\&}{ name}, \param{const wxString\&}{ value}}
 975
 976 \func{void}{SetOption}{\param{const wxString\&}{ name}, \param{int}{ value}}
 977
 978 Sets a user-defined option. The function is case-insensitive to {\it name}.
 979
 980 For example, when saving as a JPEG file, the option {\bf quality} is
 981 used, which is a number between 0 and 100 (0 is terrible, 100 is very good).
 982
 983 \wxheading{See also}
 984
 985 \helpref{wxImage::GetOption}{wximagegetoption},\rtfsp
 986 \helpref{wxImage::GetOptionInt}{wximagegetoptionint},\rtfsp
 987 \helpref{wxImage::HasOption}{wximagehasoption}
 988
 989 \membersection{wxImage::SetPalette}\label{wximagesetpalette}
 990
 991 \func{void}{SetPalette}{\param{const wxPalette\&}{ palette}}
 992
 993 Associates a palette with the image. The palette may be used when converting
 994 wxImage to wxBitmap (MSW only at present) or in file save operations (none as yet).
 995
 996 \membersection{wxImage::SetRGB}\label{wximagesetrgb}
 997
 998 \func{void}{SetRGB}{\param{int }{x}, \param{int }{y}, \param{unsigned char }{red}, \param{unsigned char }{green}, \param{unsigned char }{blue}}
 999
1000 Sets the pixel at the given coordinate. This routine performs bounds-checks
1001 for the coordinate so it can be considered a safe way to manipulate the
1002 data, but in some cases this might be too slow so that the data will have to
1003 be set directly. In that case you will have to get access to the image data
1004 using the \helpref{GetData}{wximagegetdata} method.
1005
1006 \membersection{wxImage::operator $=$}
1007
1008 \func{wxImage\& }{operator $=$}{\param{const wxImage\& }{image}}
1009
1010 Assignment operator. This operator does not copy any data, but instead
1011 passes a pointer to the data in {\it image} and increments a reference
1012 counter. It is a fast operation.
1013
1014 \wxheading{Parameters}
1015
1016 \docparam{image}{Image to assign.}
1017
1018 \wxheading{Return value}
1019
1020 Returns 'this' object.
1021
1022 \membersection{wxImage::operator $==$}
1023
1024 \constfunc{bool}{operator $==$}{\param{const wxImage\& }{image}}
1025
1026 Equality operator. This operator tests whether the internal data pointers are
1027 equal (a fast test).
1028
1029 \wxheading{Parameters}
1030
1031 \docparam{image}{Image to compare with 'this'}
1032
1033 \wxheading{Return value}
1034
1035 Returns true if the images were effectively equal, false otherwise.
1036
1037 \membersection{wxImage::operator $!=$}
1038
1039 \constfunc{bool}{operator $!=$}{\param{const wxImage\& }{image}}
1040
1041 Inequality operator. This operator tests whether the internal data pointers are
1042 unequal (a fast test).
1043
1044 \wxheading{Parameters}
1045
1046 \docparam{image}{Image to compare with 'this'}
1047
1048 \wxheading{Return value}
1049
1050 Returns true if the images were unequal, false otherwise.
1051
1052 \section{\class{wxImageHandler}}\label{wximagehandler}
1053
1054 This is the base class for implementing image file loading/saving, and image creation from data.
1055 It is used within wxImage and is not normally seen by the application.
1056
1057 If you wish to extend the capabilities of wxImage, derive a class from wxImageHandler
1058 and add the handler using \helpref{wxImage::AddHandler}{wximageaddhandler} in your
1059 application initialisation.
1060
1061 \wxheading{Note (Legal Issue)}
1062
1063 This software is based in part on the work of the Independent JPEG Group.
1064
1065 (Applies when wxWidgets is linked with JPEG support. wxJPEGHandler uses libjpeg
1066 created by IJG.)
1067
1068 \wxheading{Derived from}
1069
1070 \helpref{wxObject}{wxobject}
1071
1072 \wxheading{Include files}
1073
1074 <wx/image.h>
1075
1076 \wxheading{See also}
1077
1078 \helpref{wxImage}{wximage},
1079 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
1080
1081 \latexignore{\rtfignore{\wxheading{Members}}}
1082
1083 \membersection{wxImageHandler::wxImageHandler}\label{wximagehandlerconstr}
1084
1085 \func{}{wxImageHandler}{\void}
1086
1087 Default constructor. In your own default constructor, initialise the members
1088 m\_name, m\_extension and m\_type.
1089
1090 \membersection{wxImageHandler::\destruct{wxImageHandler}}
1091
1092 \func{}{\destruct{wxImageHandler}}{\void}
1093
1094 Destroys the wxImageHandler object.
1095
1096 \membersection{wxImageHandler::GetName}
1097
1098 \constfunc{wxString}{GetName}{\void}
1099
1100 Gets the name of this handler.
1101
1102 \membersection{wxImageHandler::GetExtension}
1103
1104 \constfunc{wxString}{GetExtension}{\void}
1105
1106 Gets the file extension associated with this handler.
1107
1108 \membersection{wxImageHandler::GetImageCount}\label{wximagehandlergetimagecount}
1109
1110 \func{int}{GetImageCount}{\param{wxInputStream\&}{ stream}}
1111
1112 If the image file contains more than one image and the image handler is capable
1113 of retrieving these individually, this function will return the number of
1114 available images.
1115
1116 \docparam{stream}{Opened input stream for reading image data. Currently, the stream must support seeking.}
1117
1118 \wxheading{Return value}
1119
1120 Number of available images. For most image handlers, this is 1 (exceptions
1121 are TIFF and ICO formats).
1122
1123 \membersection{wxImageHandler::GetType}
1124
1125 \constfunc{long}{GetType}{\void}
1126
1127 Gets the image type associated with this handler.
1128
1129 \membersection{wxImageHandler::GetMimeType}
1130
1131 \constfunc{wxString}{GetMimeType}{\void}
1132
1133 Gets the MIME type associated with this handler.
1134
1135 \membersection{wxImageHandler::LoadFile}\label{wximagehandlerloadfile}
1136
1137 \func{bool}{LoadFile}{\param{wxImage* }{image}, \param{wxInputStream\&}{ stream}, \param{bool}{ verbose=true}, \param{int}{ index=0}}
1138
1139 Loads a image from a stream, putting the resulting data into {\it image}. If the image file contains
1140 more than one image and the image handler is capable of retrieving these individually, {\it index}
1141 indicates which image to read from the stream.
1142
1143 \wxheading{Parameters}
1144
1145 \docparam{image}{The image object which is to be affected by this operation.}
1146
1147 \docparam{stream}{Opened input stream for reading image data.}
1148
1149 \docparam{verbose}{If set to true, errors reported by the image handler will produce wxLogMessages.}
1150
1151 \docparam{index}{The index of the image in the file (starting from zero).}
1152
1153 \wxheading{Return value}
1154
1155 true if the operation succeeded, false otherwise.
1156
1157 \wxheading{See also}
1158
1159 \helpref{wxImage::LoadFile}{wximageloadfile},
1160 \helpref{wxImage::SaveFile}{wximagesavefile},
1161 \helpref{wxImageHandler::SaveFile}{wximagehandlersavefile}
1162
1163 \membersection{wxImageHandler::SaveFile}\label{wximagehandlersavefile}
1164
1165 \func{bool}{SaveFile}{\param{wxImage* }{image}, \param{wxOutputStream\& }{stream}}
1166
1167 Saves a image in the output stream.
1168
1169 \wxheading{Parameters}
1170
1171 \docparam{image}{The image object which is to be affected by this operation.}
1172
1173 \docparam{stream}{Opened output stream for writing the data.}
1174
1175 \wxheading{Return value}
1176
1177 true if the operation succeeded, false otherwise.
1178
1179 \wxheading{See also}
1180
1181 \helpref{wxImage::LoadFile}{wximageloadfile},
1182 \helpref{wxImage::SaveFile}{wximagesavefile},
1183 \helpref{wxImageHandler::LoadFile}{wximagehandlerloadfile}
1184
1185 \membersection{wxImageHandler::SetName}
1186
1187 \func{void}{SetName}{\param{const wxString\& }{name}}
1188
1189 Sets the handler name.
1190
1191 \wxheading{Parameters}
1192
1193 \docparam{name}{Handler name.}
1194
1195 \membersection{wxImageHandler::SetExtension}
1196
1197 \func{void}{SetExtension}{\param{const wxString\& }{extension}}
1198
1199 Sets the handler extension.
1200
1201 \wxheading{Parameters}
1202
1203 \docparam{extension}{Handler extension.}
1204
1205 \membersection{wxImageHandler::SetMimeType}\label{wximagehandlersetmimetype}
1206
1207 \func{void}{SetMimeType}{\param{const wxString\& }{mimetype}}
1208
1209 Sets the handler MIME type.
1210
1211 \wxheading{Parameters}
1212
1213 \docparam{mimename}{Handler MIME type.}
1214
1215 \membersection{wxImageHandler::SetType}
1216
1217 \func{void}{SetType}{\param{long }{type}}
1218
1219 Sets the handler type.
1220
1221 \wxheading{Parameters}
1222
1223 \docparam{name}{Handler type.}
1224