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 the constructor taking a wxBitmap object. 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 wxDC. Instead, a platform-specific
  10 wxBitmap object must be created from it, and that bitmap drawn on the wxDC, using
  11 wxDC::DrawBitmap.
  12
  13 \wxheading{Derived from}
  14
  15 \helpref{wxObject}{wxobject}
  16
  17 \wxheading{Include files}
  18
  19 <wx/image.h>
  20
  21 \wxheading{See also}
  22
  23 \helpref{wxBitmap}{wxbitmap}
  24 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
  25
  26 \latexignore{\rtfignore{\wxheading{Members}}}
  27
  28 \membersection{wxImage::wxImage}\label{wximageconstr}
  29
  30 \func{}{wxImage}{\void}
  31
  32 Default constructor.
  33
  34 \func{}{wxImage}{\param{const wxImage\& }{image}}
  35
  36 Copy constructor.
  37
  38 \func{}{wxImage}{\param{const wxBitmap\&}{ bitmap}}
  39
  40 Constructs an image from a platform-dependent bitmap. This preserves
  41 mask information so that bitmaps and images can be converted back
  42 and forth without loss in that respect.
  43
  44 \func{}{wxImage}{\param{int}{ width}, \param{int}{ height}}
  45
  46 Creates an image with the given width and height.
  47
  48 \func{}{wxImage}{\param{const wxString\& }{name}, \param{long}{ type = wxBITMAP\_TYPE\_PNG}}
  49
  50 \func{}{wxImage}{\param{const wxString\& }{name}, \param{const wxString\&}{ mimetype}}
  51
  52 Loads an image from a file.
  53
  54 \func{}{wxImage}{\param{wxInputStream\& }{stream}, \param{long}{ type = wxBITMAP\_TYPE\_PNG}}
  55
  56 \func{}{wxImage}{\param{wxInputStream\& }{stream}, \param{const wxString\&}{ mimetype}}
  57
  58 Loads an image from an input stream.
  59
  60 \wxheading{Parameters}
  61
  62 \docparam{width}{Specifies the width of the image.}
  63
  64 \docparam{height}{Specifies the height of the image.}
  65
  66 \docparam{name}{This refers to an image filename. Its meaning is determined by the {\it type} parameter.}
  67
  68 \docparam{stream}{This refers to an input stream. Its meaning is determined by the {\it type} parameter. It is equal to loading from file except that you provide opened stream (file, HTTP or any other custom class).}
  69
  70 \docparam{type}{May be one of the following:
  71
  72 \twocolwidtha{5cm}%
  73 \begin{twocollist}
  74 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_BMP}}}{Load a Windows bitmap file.}
  75 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_PNG}}}{Load a PNG bitmap file.}
  76 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_JPEG}}}{Load a JPEG bitmap file.}
  77 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_GIF}}}{Load a GIF bitmap file.}
  78 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_PCX}}}{Load a PCX bitmap file.}
  79 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_PNM}}}{Load a PNM bitmap file.}
  80 \end{twocollist}
  81
  82 The validity of these flags depends on the platform and wxWindows configuration.
  83 If all possible wxWindows settings are used, the loading a BMP (Windows bitmap) file,
  84 a PNG (portable network graphics) file and a JPEG file is supported on all platforms that
  85 implement wxImage.}
  86
  87 \docparam{mimetype}{MIME type string (for example 'image/jpeg')}
  88
  89 Note : you must call wxImage::AddHandler(new wxJPEGHandler) during application
  90 initialization in order to work with JPEGs.
  91
  92 \wxheading{See also}
  93
  94 \helpref{wxImage::LoadFile}{wximageloadfile}
  95
  96 \pythonnote{Constructors supported by wxPython are:\par
  97 \indented{2cm}{\begin{twocollist}
  98 \twocolitem{\bf{wxImage(name, flag)}}{Loads an image from a file}
  99 \twocolitem{\bf{wxNullImage()}}{Create a null image (has no size or
 100 image data)}
 101 \twocolitem{\bf{wxEmptyImage(width, height)}}{Creates an empty image
 102 of the given size}
 103 \twocolitem{\bf{wxImageFromMime(name, mimetype}}{Creates an image from
 104 the given file of the given mimetype}
 105 \twocolitem{\bf{wxImageFromBitmap(bitmap)}}{Creates an image from a
 106 platform-dependent bitmap}
 107 \end{twocollist}}
 108 }
 109
 110 \membersection{wxImage::\destruct{wxImage}}
 111
 112 \func{}{\destruct{wxImage}}{\void}
 113
 114 Destructor.
 115
 116 \membersection{wxImage::AddHandler}\label{wximageaddhandler}
 117
 118 \func{static void}{AddHandler}{\param{wxImageHandler*}{ handler}}
 119
 120 Adds a handler to the end of the static list of format handlers.
 121
 122 \docparam{handler}{A new image format handler object. There is usually only one instance
 123 of a given handler class in an application session.}
 124
 125 \wxheading{See also}
 126
 127 \helpref{wxImageHandler}{wximagehandler}
 128
 129 \pythonnote{In wxPython this static method is named \tt{wxImage_AddHandler}.}
 130 \membersection{wxImage::CleanUpHandlers}
 131
 132 \func{static void}{CleanUpHandlers}{\void}
 133
 134 Deletes all image handlers.
 135
 136 This function is called by wxWindows on exit.
 137
 138 \membersection{wxImage::ConvertToBitmap}\label{wximageconverttobitmap}
 139
 140 \constfunc{wxBitmap}{ConvertToBitmap}{\void}
 141
 142 Converts the image to a platform-specific bitmap object. This has to be done
 143 to actually display an image as you cannot draw an image directly on a window.
 144 The resulting bitmap will use the colour depth of the current system which entails
 145 that a (crude) colour reduction has to take place. When in 8-bit mode, this
 146 routine will use a color cube created on program start-up to look up colors.
 147 Still, the image quality won't be perfect for photo images.
 148
 149 \membersection{wxImage::Create}\label{wximagecreate}
 150
 151 \func{bool}{Create}{\param{int}{ width}, \param{int}{ height}}
 152
 153 Creates a fresh image.
 154
 155 \wxheading{Parameters}
 156
 157 \docparam{width}{The width of the image in pixels.}
 158
 159 \docparam{height}{The height of the image in pixels.}
 160
 161 \wxheading{Return value}
 162
 163 TRUE if the call succeeded, FALSE otherwise.
 164
 165 \membersection{wxImage::Destroy}\label{wximagedestroy}
 166
 167 \func{bool}{Destroy}{\void}
 168
 169 Destroys the image data.
 170
 171 \membersection{wxImage::FindHandler}
 172
 173 \func{static wxImageHandler*}{FindHandler}{\param{const wxString\& }{name}}
 174
 175 Finds the handler with the given name.
 176
 177 \func{static wxImageHandler*}{FindHandler}{\param{const wxString\& }{extension}, \param{long}{ imageType}}
 178
 179 Finds the handler associated with the given extension and type.
 180
 181 \func{static wxImageHandler*}{FindHandler}{\param{long }{imageType}}
 182
 183 Finds the handler associated with the given image type.
 184
 185 \func{static wxImageHandler*}{FindHandlerMime}{\param{const wxString\& }{mimetype}}
 186
 187 Finds the handler associated with the given MIME type.
 188
 189 \docparam{name}{The handler name.}
 190
 191 \docparam{extension}{The file extension, such as ``bmp".}
 192
 193 \docparam{imageType}{The image type, such as wxBITMAP\_TYPE\_BMP.}
 194
 195 \docparam{mimetype}{MIME type.}
 196
 197 \wxheading{Return value}
 198
 199 A pointer to the handler if found, NULL otherwise.
 200
 201 \wxheading{See also}
 202
 203 \helpref{wxImageHandler}{wximagehandler}
 204
 205 \membersection{wxImage::GetBlue}\label{wximagegetblue}
 206
 207 \constfunc{unsigned char}{GetBlue}{\param{int}{ x}, \param{int}{ y}}
 208
 209 Returns the blue intensity at the given coordinate.
 210
 211 \membersection{wxImage::GetData}\label{wximagegetdata}
 212
 213 \constfunc{unsigned char*}{GetData}{\void}
 214
 215 Returns the image data as an array. This is most often used when doing
 216 direct image manipulation. The return value points to an array of
 217 chararcters in RGBGBRGB... format.
 218
 219 \membersection{wxImage::GetGreen}\label{wximagegetgreen}
 220
 221 \constfunc{unsigned char}{GetGreen}{\param{int}{ x}, \param{int}{ y}}
 222
 223 Returns the green intensity at the given coordinate.
 224
 225 \membersection{wxImage::GetRed}\label{wximagegetred}
 226
 227 \constfunc{unsigned char}{GetRed}{\param{int}{ x}, \param{int}{ y}}
 228
 229 Returns the red intensity at the given coordinate.
 230
 231 \membersection{wxImage::GetHandlers}
 232
 233 \func{static wxList\&}{GetHandlers}{\void}
 234
 235 Returns the static list of image format handlers.
 236
 237 \wxheading{See also}
 238
 239 \helpref{wxImageHandler}{wximagehandler}
 240
 241 \membersection{wxImage::GetHeight}\label{wximagegetheight}
 242
 243 \constfunc{int}{GetHeight}{\void}
 244
 245 Gets the height of the image in pixels.
 246
 247 \membersection{wxImage::GetMaskBlue}\label{wximagegetmaskblue}
 248
 249 \constfunc{unsigned char}{GetMaskBlue}{\void}
 250
 251 Gets the blue value of the mask colour.
 252
 253 \membersection{wxImage::GetMaskGreen}\label{wximagegetmaskgreen}
 254
 255 \constfunc{unsigned char}{GetMaskGreen}{\void}
 256
 257 Gets the green value of the mask colour.
 258
 259 \membersection{wxImage::GetMaskRed}\label{wximagegetmaskred}
 260
 261 \constfunc{unsigned char}{GetMaskRed}{\void}
 262
 263 Gets the red value of the mask colour.
 264
 265 \membersection{wxImage::GetSubImage}\label{wximagegetsubimage}
 266
 267 \constfunc{wxImage}{GetSubImage}{\param{const wxRect&}{rect}}
 268
 269 Returns a sub image of the current one as long as the rect belongs entirely to
 270 the image.
 271
 272 \membersection{wxImage::GetWidth}\label{wximagegetwidth}
 273
 274 \constfunc{int}{GetWidth}{\void}
 275
 276 Gets the width of the image in pixels.
 277
 278 \wxheading{See also}
 279
 280 \helpref{wxImage::GetHeight}{wximagegetheight}
 281
 282 \membersection{wxImage::HasMask}\label{wximagehasmask}
 283
 284 \constfunc{bool}{HasMask}{\void}
 285
 286 Returns TRUE if there is a mask active, FALSE otherwise.
 287
 288 \membersection{wxImage::InitStandardHandlers}
 289
 290 \func{static void}{InitStandardHandlers}{\void}
 291
 292 Internal use only. Adds standard image format handlers. It only install BMP
 293 for the time being, which is use by wxBitmap.
 294
 295 This function is called by wxWindows on startup, and shouldn't be called by
 296 the user.
 297
 298 \wxheading{See also}
 299
 300 \helpref{wxImageHandler}{wximagehandler}
 301 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
 302
 303 \membersection{wxImage::InsertHandler}
 304
 305 \func{static void}{InsertHandler}{\param{wxImageHandler*}{ handler}}
 306
 307 Adds a handler at the start of the static list of format handlers.
 308
 309 \docparam{handler}{A new image format handler object. There is usually only one instance
 310 of a given handler class in an application session.}
 311
 312 \wxheading{See also}
 313
 314 \helpref{wxImageHandler}{wximagehandler}
 315
 316 \membersection{wxImage::LoadFile}\label{wximageloadfile}
 317
 318 \func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}}
 319
 320 \func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{const wxString\&}{ mimetype}}
 321
 322 Loads an image from a file. If no handler type is provided, the library will
 323 try to use wxBITMAP\_TYPE\_BMP.
 324
 325 \func{bool}{LoadFile}{\param{wxInputStream\&}{ stream}, \param{long}{ type}}
 326
 327 \func{bool}{LoadFile}{\param{wxInputStream\&}{ stream}, \param{const wxString\&}{ mimetype}}
 328
 329 Loads an image from an input stream.
 330
 331 \wxheading{Parameters}
 332
 333 \docparam{name}{A filename.
 334 The meaning of {\it name} is determined by the {\it type} parameter.}
 335
 336 \docparam{stream}{An input stream.
 337 The meaning of {\it stream} data is determined by the {\it type} parameter.}
 338
 339 \docparam{type}{One of the following values:
 340
 341 \twocolwidtha{5cm}%
 342 \begin{twocollist}
 343 \twocolitem{{\bf wxBITMAP\_TYPE\_BMP}}{Load a Windows image file.}
 344 \twocolitem{{\bf wxBITMAP\_TYPE\_GIF}}{Load a GIF image file.}
 345 \twocolitem{{\bf wxBITMAP\_TYPE\_JPEG}}{Load a JPEG image file.}
 346 \twocolitem{{\bf wxBITMAP\_TYPE\_PCX}}{Load a PCX image file.}
 347 \twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Load a PNG image file.}
 348 \twocolitem{{\bf wxBITMAP\_TYPE\_PNM}}{Load a PNM image file.}
 349 \end{twocollist}
 350
 351 The validity of these flags depends on the platform and wxWindows configuration.}
 352
 353 \docparam{mimetype}{MIME type string (for example 'image/jpeg')}
 354
 355 \wxheading{Return value}
 356
 357 TRUE if the operation succeeded, FALSE otherwise.
 358
 359 \wxheading{See also}
 360
 361 \helpref{wxImage::SaveFile}{wximagesavefile}
 362
 363 \pythonnote{In place of a single overloaded method name, wxPython
 364 implements the following methods:\par
 365 \indented{2cm}{\begin{twocollist}
 366 \twocolitem{\bf{LoadFile(filename, type)}}{Loads an image of the given
 367 type from a file}
 368 \twocolitem{\bf{LoadMimeFile(filename, mimetype)}}{Loads an image of the given
 369 mimetype from a file}
 370 \end{twocollist}}
 371 }
 372
 373
 374 \membersection{wxImage::Ok}\label{wximageok}
 375
 376 \constfunc{bool}{Ok}{\void}
 377
 378 Returns TRUE if image data is present.
 379
 380 \membersection{wxImage::RemoveHandler}
 381
 382 \func{static bool}{RemoveHandler}{\param{const wxString\& }{name}}
 383
 384 Finds the handler with the given name, and removes it. The handler
 385 is not deleted.
 386
 387 \docparam{name}{The handler name.}
 388
 389 \wxheading{Return value}
 390
 391 TRUE if the handler was found and removed, FALSE otherwise.
 392
 393 \wxheading{See also}
 394
 395 \helpref{wxImageHandler}{wximagehandler}
 396
 397 \membersection{wxImage::SaveFile}\label{wximagesavefile}
 398
 399 \func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{int}{ type}}
 400
 401 \func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{const wxString\&}{ mimetype}}
 402
 403 Saves a image in the named file.
 404
 405 \func{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{int}{ type}}
 406
 407 \func{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{const wxString\&}{ mimetype}}
 408
 409 Saves a image in the given stream.
 410
 411 \wxheading{Parameters}
 412
 413 \docparam{name}{A filename. The meaning of {\it name} is determined by the {\it type} parameter.}
 414
 415 \docparam{stream}{An output stream. The meaning of {\it stream} is determined by the {\it type} parameter.}
 416
 417 \docparam{type}{Currently two types can be used:
 418
 419 \twocolwidtha{5cm}%
 420 \begin{twocollist}
 421 \twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Save a PNG image file.}
 422 \twocolitem{{\bf wxBITMAP\_TYPE\_JPEG}}{Save a JPEG image file.}
 423 \end{twocollist}
 424
 425 The validity of these flags depends on the platform and wxWindows configuration
 426 as well as user-added handlers.}
 427
 428 \docparam{mimetype}{MIME type.}
 429
 430 \wxheading{Return value}
 431
 432 TRUE if the operation succeeded, FALSE otherwise.
 433
 434 \wxheading{Remarks}
 435
 436 Depending on how wxWindows has been configured, not all formats may be available.
 437
 438 \wxheading{See also}
 439
 440 \helpref{wxImage::LoadFile}{wximageloadfile}
 441
 442 \pythonnote{In place of a single overloaded method name, wxPython
 443 implements the following methods:\par
 444 \indented{2cm}{\begin{twocollist}
 445 \twocolitem{\bf{SaveFile(filename, type)}}{Saves the image using the given
 446 type to the named file}
 447 \twocolitem{\bf{SaveMimeFile(filename, mimetype)}}{Saves the image using the given
 448 mimetype to the named file}
 449 \end{twocollist}}
 450 }
 451
 452 \membersection{wxImage::Rescale}\label{wximagerescale}
 453
 454 \func{wxImage \&}{Rescale}{\param{int}{ width}, \param{int}{ height}}
 455
 456 Changes the size of the image in-place: after a call to this function, the
 457 image will have the given width and height.
 458
 459 Returns the (modified) image itself.
 460
 461 \wxheading{See also}
 462
 463 \helpref{Scale}{wximagescale}
 464
 465 \membersection{wxImage::Scale}\label{wximagescale}
 466
 467 \constfunc{wxImage}{Scale}{\param{int}{ width}, \param{int}{ height}}
 468
 469 Returns a scaled version of the image. This is also useful for
 470 scaling bitmaps in general as the only other way to scale bitmaps
 471 is to blit a wxMemoryDC into another wxMemoryDC.
 472
 473 It may be mentioned that the GTK post uses this function internally
 474 to scale bitmaps when using mapping mode in wxDC.
 475
 476 Example:
 477
 478 \begin{verbatim}
 479     // get the bitmap from somewhere
 480     wxBitmap bmp = ...;
 481
 482     // rescale it to have size of 32*32
 483     if ( bmp.GetWidth() != 32 || bmp.GetHeight() != 32 )
 484     {
 485         wxImage image(bmp);
 486         bmp = image.Scale(32, 32).ConvertToBitmap();
 487
 488         // another possibility:
 489         image.Rescale(32, 32);
 490         bmp = image;
 491     }
 492
 493 \end{verbatim}
 494
 495 \wxheading{See also}
 496
 497 \helpref{Rescale}{wximagerescale}
 498
 499 \membersection{wxImage::SetData}\label{wximagesetdata}
 500
 501 \func{void}{SetData}{\param{unsigned char*}{data}}
 502
 503 Sets the image data without performing checks. The data given must have
 504 the size (width*height*3) or results will be unexpected. Don't use this
 505 method if you aren't sure you know what you are doing.
 506
 507 \membersection{wxImage::SetMask}\label{wximagesetmask}
 508
 509 \func{void}{SetMask}{\param{bool}{ hasMask = TRUE}}
 510
 511 Specifies whether there is a mask or not. The area of the mask is determined by the current mask colour.
 512
 513 \membersection{wxImage::SetMaskColour}\label{wximagesetmaskcolour}
 514
 515 \func{void}{SetMaskColour}{\param{unsigned char }{red}, \param{unsigned char }{blue}, \param{unsigned char }{green}}
 516
 517 Sets the mask colour for this image (and tells the image to use the mask).
 518
 519 \membersection{wxImage::SetRGB}\label{wximagesetrgb}
 520
 521 \func{void}{SetRGB}{\param{int }{x}, \param{int }{y}, \param{unsigned char }{red}, \param{unsigned char }{blue}, \param{unsigned char }{green}}
 522
 523 Sets the pixel at the given coordinate. This routine performs bounds-checks
 524 for the coordinate so it can be considered a safe way to manipulate the
 525 data, but in some cases this might be too slow so that the data will have to
 526 be set directly. In that case you have to get that data by calling GetData().
 527
 528 \membersection{wxImage::operator $=$}
 529
 530 \func{wxImage\& }{operator $=$}{\param{const wxImage\& }{image}}
 531
 532 Assignment operator. This operator does not copy any data, but instead
 533 passes a pointer to the data in {\it image} and increments a reference
 534 counter. It is a fast operation.
 535
 536 \wxheading{Parameters}
 537
 538 \docparam{image}{Image to assign.}
 539
 540 \wxheading{Return value}
 541
 542 Returns 'this' object.
 543
 544 \membersection{wxImage::operator $==$}
 545
 546 \func{bool}{operator $==$}{\param{const wxImage\& }{image}}
 547
 548 Equality operator. This operator tests whether the internal data pointers are
 549 equal (a fast test).
 550
 551 \wxheading{Parameters}
 552
 553 \docparam{image}{Image to compare with 'this'}
 554
 555 \wxheading{Return value}
 556
 557 Returns TRUE if the images were effectively equal, FALSE otherwise.
 558
 559 \membersection{wxImage::operator $!=$}
 560
 561 \func{bool}{operator $!=$}{\param{const wxImage\& }{image}}
 562
 563 Inequality operator. This operator tests whether the internal data pointers are
 564 unequal (a fast test).
 565
 566 \wxheading{Parameters}
 567
 568 \docparam{image}{Image to compare with 'this'}
 569
 570 \wxheading{Return value}
 571
 572 Returns TRUE if the images were unequal, FALSE otherwise.
 573
 574 \section{\class{wxImageHandler}}\label{wximagehandler}
 575
 576 This is the base class for implementing image file loading/saving, and image creation from data.
 577 It is used within wxImage and is not normally seen by the application.
 578
 579 If you wish to extend the capabilities of wxImage, derive a class from wxImageHandler
 580 and add the handler using \helpref{wxImage::AddHandler}{wximageaddhandler} in your
 581 application initialisation.
 582
 583 \wxheading{Note (Legal Issue)}
 584
 585 This software is based in part on the work of the Independent JPEG Group.
 586
 587 (Applies when wxWindows is linked with JPEG support. wxJPEGHandler uses libjpeg
 588 created by IJG.)
 589
 590 \wxheading{Derived from}
 591
 592 \helpref{wxObject}{wxobject}
 593
 594 \wxheading{Include files}
 595
 596 <wx/image.h>
 597
 598 \wxheading{See also}
 599
 600 \helpref{wxImage}{wximage}
 601 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
 602
 603 \latexignore{\rtfignore{\wxheading{Members}}}
 604
 605 \membersection{wxImageHandler::wxImageHandler}\label{wximagehandlerconstr}
 606
 607 \func{}{wxImageHandler}{\void}
 608
 609 Default constructor. In your own default constructor, initialise the members
 610 m\_name, m\_extension and m\_type.
 611
 612 \membersection{wxImageHandler::\destruct{wxImageHandler}}
 613
 614 \func{}{\destruct{wxImageHandler}}{\void}
 615
 616 Destroys the wxImageHandler object.
 617
 618 \membersection{wxImageHandler::GetName}
 619
 620 \constfunc{wxString}{GetName}{\void}
 621
 622 Gets the name of this handler.
 623
 624 \membersection{wxImageHandler::GetExtension}
 625
 626 \constfunc{wxString}{GetExtension}{\void}
 627
 628 Gets the file extension associated with this handler.
 629
 630 \membersection{wxImageHandler::GetImageCount}\label{wximagehandlergetimagecount}
 631
 632 \func{int}{GetImageCount}{\param{wxInputStream\&}{ stream}}
 633
 634 If the image file contains more than one image and the image handler is capable
 635 of retrieving these individually, this function will return the number of
 636 available images.
 637
 638 \docparam{stream}{Opened input stream for reading image file.}
 639
 640 \wxheading{Return value}
 641
 642 Number of available images. For most image handles, this defaults to 1.
 643
 644 \membersection{wxImageHandler::GetType}
 645
 646 \constfunc{long}{GetType}{\void}
 647
 648 Gets the image type associated with this handler.
 649
 650 \membersection{wxImageHandler::GetMimeType}
 651
 652 \constfunc{wxString}{GetMimeType}{\void}
 653
 654 Gets the MIME type associated with this handler.
 655
 656 \membersection{wxImageHandler::LoadFile}\label{wximagehandlerloadfile}
 657
 658 \func{bool}{LoadFile}{\param{wxImage* }{image}, \param{wxInputStream\&}{ stream}, \param{bool}{ verbose=TRUE}, \param{int}{ index=0}}
 659
 660 Loads a image from a stream, putting the resulting data into {\it image}. If the image file contains
 661 more than one image and the image handler is capable of retrieving these individually, {\it index}
 662 indicates which image to read from the stream.
 663
 664 \wxheading{Parameters}
 665
 666 \docparam{image}{The image object which is to be affected by this operation.}
 667
 668 \docparam{stream}{Opened input stream for reading images.}
 669
 670 \docparam{verbose}{If set to TRUE, errors reported by the image handler will produce wxLogMessages.}
 671
 672 \docparam{index}{The index of the image in the file (starting from zero).}
 673
 674 \wxheading{Return value}
 675
 676 TRUE if the operation succeeded, FALSE otherwise.
 677
 678 \wxheading{See also}
 679
 680 \helpref{wxImage::LoadFile}{wximageloadfile}\\
 681 \helpref{wxImage::SaveFile}{wximagesavefile}\\
 682 \helpref{wxImageHandler::SaveFile}{wximagehandlersavefile}
 683
 684 \membersection{wxImageHandler::SaveFile}\label{wximagehandlersavefile}
 685
 686 \func{bool}{SaveFile}{\param{wxImage* }{image}, \param{wxOutputStream\& }{stream}}
 687
 688 Saves a image in the output stream.
 689
 690 \wxheading{Parameters}
 691
 692 \docparam{image}{The image object which is to be affected by this operation.}
 693
 694 \docparam{stream}{An opened stream for writing images.}
 695
 696 \wxheading{Return value}
 697
 698 TRUE if the operation succeeded, FALSE otherwise.
 699
 700 \wxheading{See also}
 701
 702 \helpref{wxImage::LoadFile}{wximageloadfile}\\
 703 \helpref{wxImage::SaveFile}{wximagesavefile}\\
 704 \helpref{wxImageHandler::LoadFile}{wximagehandlerloadfile}
 705
 706 \membersection{wxImageHandler::SetName}
 707
 708 \func{void}{SetName}{\param{const wxString\& }{name}}
 709
 710 Sets the handler name.
 711
 712 \wxheading{Parameters}
 713
 714 \docparam{name}{Handler name.}
 715
 716 \membersection{wxImageHandler::SetExtension}
 717
 718 \func{void}{SetExtension}{\param{const wxString\& }{extension}}
 719
 720 Sets the handler extension.
 721
 722 \wxheading{Parameters}
 723
 724 \docparam{extension}{Handler extension.}
 725
 726 \membersection{wxImageHandler::SetType}
 727
 728 \func{void}{SetType}{\param{long }{type}}
 729
 730 Sets the handler type.
 731
 732 \wxheading{Parameters}
 733
 734 \docparam{name}{Handler type.}
 735
 736
 737 \membersection{wxImageHandler::SetMimeType}
 738
 739 \func{void}{SetMimeType}{\param{const wxString\& }{mimetype}}
 740
 741 Sets the handler MIME type.
 742
 743 \wxheading{Parameters}
 744
 745 \docparam{mimename}{Handler MIME type.}
 746