wxImageHandler
generated from ../src/mod_gui/misc/imghand.cppwxImageHandler is the prototype for several image handlers. See wxImage, wxBMPHandler, wxGIFHandler, wxICOHandler, wxJPEGHandler, wxPCXHandler, wxPNGHandler, wxPNMHandler, wxTIFFHandler, wxXPMHandler
Constants
Properties
| Name | Type | Description |
|---|---|---|
| extension | String | Get/Set the handler extension. |
| mimeType | String | Get/Set the handler MIME type. |
| name | String | Get/Set the handler name. |
| type | Integer | Get/Set the handler type. |
Methods
getImageCount
getImageCount(Filename) : Integer
| Name | Type | Default | Description |
|---|---|---|---|
| Filename | String | A file that contains an image. |
If the image file contains more than one image and the image handler is capable of retrieving these individually, this function will return the number of available images. Most imagehandlers return 1.
Unlike wxWidgets this method expects a filename instead of an inputstream.
loadFile
loadFile(Image,
File,
Verbose = true,
Index = 0) : Boolean
| Name | Type | Default | Description |
|---|---|---|---|
| Image | wxImage | The object that gets the loaded image. | |
| File | String | The name of the image file. | |
| Verbose | Boolean | true | When true the image handler will report errors using wxLog |
| Index | Integer | 0 | The index of the image in the file (zero-based). |
Loads a image from a file, putting the resulting data into image. If the image file contains more than one image and the image handler is capable of retrieving these individually, index indicates which image to read from the stream. Returns true when successful, false otherwise.
Unlike wxWidgets this method expects a filename instead of an inputstream.
saveFile
saveFile(Image,
Filename,
Verbose = true) : Boolean
| Name | Type | Default | Description |
|---|---|---|---|
| Image | wxImage | The object that gets the loaded image. | |
| Filename | String | Opened output stream for writing the image data. | |
| Verbose | Boolean | true | When true the image handler will report errors using wxLog |
Saves a image to a file. Returns true on success, false otherwise.
Unlike wxWidgets this method expects a filename instead of an inputstream.
© 2002 - 2007 Franky Braem.