.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxImageHandler 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxImageHandler \- 
.SH DESCRIPTION

  


   This is the base class for implementing image file loading/saving, and image
   creation from data. It is used within wxImage and is not normally seen by the
   application.
  
  


   If you wish to extend the capabilities of wxImage, derive a class from
   wxImageHandler and add the handler using
   wxImage::AddHandler
   in your application initialisation.
  
 
.SH NOTE

  Legal issue: This software is based in part on the work of the Independent JPEG Group. (Applies when wxWidgets is linked with JPEG support. wxJPEGHandler uses libjpeg created by IJG.)
 
.SH "PARENTS"

  wxObject
 
.SH "INCLUDE FILES"
wx/image.h
.SH MEMBERS

  
.SS  wxImageHandler ()

     


      Default constructor. In your own default constructor, initialise the
      members m_name, m_extension and m_type.
     
    
   
  
.SS  ~wxImageHandler ()

     


      Destroys the wxImageHandler object.
     
    
   
  
.SS wxString GetName ()

     


      Gets the name of this handler.
     
    
   
  
.SS wxString GetExtension ()

     


      Gets the file extension associated with this handler.
     
    
   
  
.SS int GetImageCount (wxInputStream& stream)

     


      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.
     
    
   
  
.SS long GetType ()

     


      Gets the image type associated with this handler.
     
    
   
  
.SS wxString GetMimeType ()

     


      Gets the MIME type associated with this handler.
     
    
   
  
.SS bool LoadFile (wxImage* imagewxInputStream& streambool verbose = trueint index = 0)

   
  
.SS bool SaveFile (wxImage* imagewxOutputStream& stream)

   
  
.SS void SetName (const wxString& name)

     


      Sets the handler name.
     
    
   
  
.SS void SetExtension (const wxString& extension)

     


      Sets the handler extension.
     
    
   
  
.SS void SetMimeType (const wxString& mimetype)

     


      Sets the handler MIME type.
     
    
   
  
.SS void SetType (long type)

     


      Sets the handler type.
     
    
 
.SH "SEE ALSO"

  wxObject
 
  wxImage
   
  wxInitAllImageHandlers
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.