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

  


   Overview
  
  


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


   If you wish to extend the capabilities of wxBitmap, derive a class from
   wxBitmapHandler and add the handler using
   wxBitmap::AddHandler
   in your application initialisation.
  
 
.SH "PARENTS"

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

  
.SS  wxBitmapHandler ()

     


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

     


      Destroys the wxBitmapHandler object.
     
    
   
  
.SS virtual bool Create (wxBitmap* bitmapvoid* dataint typeint widthint heightint depth = -1)

     


      Creates a bitmap from the given data, which can be of arbitrary type. The
      wxBitmap object
      
       bitmap
      
      is manipulated by this function.
     
    
   
  
.SS wxString GetName ()

     


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

     


      Gets the file extension associated with this handler.
     
    
   
  
.SS long GetType ()

     


      Gets the bitmap type associated with this handler.
     
    
   
  
.SS bool LoadFile (wxBitmap* bitmapconst wxString& namelong type)

     


      Loads a bitmap from a file or resource, putting the resulting data into
      
       bitmap
      
      .
     
    
   
  
.SS bool SaveFile (wxBitmap* bitmapconst wxString& nameint typewxPalette* palette = NULL)

     


      Saves a bitmap in the named file.
     
    
   
  
.SS void SetName (const wxString& name)

     


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

     


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

     


      Sets the handler type.
     
    
 
.SH "SEE ALSO"

  wxObject
 
  wxBitmap
  wxIcon
  wxCursor
 
.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.