include/wx/image.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        image.h
   3 // Purpose:     wxImage class
   4 // Author:      Robert Roebling
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_IMAGE_H_
  11 #define _WX_IMAGE_H_
  12
  13 #ifdef __GNUG__
  14 #pragma interface "image.h"
  15 #endif
  16
  17 #include "wx/setup.h"
  18 #include "wx/object.h"
  19 #include "wx/string.h"
  20 #include "wx/gdicmn.h"
  21
  22 #if wxUSE_STREAMS
  23 #include "wx/stream.h"
  24 #endif
  25
  26 //-----------------------------------------------------------------------------
  27 // classes
  28 //-----------------------------------------------------------------------------
  29
  30 class WXDLLEXPORT wxImageHandler;
  31 #if wxUSE_LIBPNG
  32 class WXDLLEXPORT wxPNGHandler;
  33 #endif
  34 #if wxUSE_LIBJPEG
  35 class WXDLLEXPORT wxJPEGHandler;
  36 #endif
  37 class WXDLLEXPORT wxBMPHandler;
  38 class WXDLLEXPORT wxImage;
  39
  40 class WXDLLEXPORT wxBitmap;
  41
  42 //-----------------------------------------------------------------------------
  43 // wxImageHandler
  44 //-----------------------------------------------------------------------------
  45
  46 class WXDLLEXPORT wxImageHandler: public wxObject
  47 {
  48   DECLARE_DYNAMIC_CLASS(wxImageHandler)
  49
  50 public:
  51   wxImageHandler() { m_name = ""; m_extension = ""; m_type = 0; }
  52
  53 #if wxUSE_STREAMS
  54   virtual bool LoadFile( wxImage *image, wxInputStream& stream );
  55   virtual bool SaveFile( wxImage *image, wxOutputStream& stream );
  56 #endif
  57
  58   inline void SetName(const wxString& name) { m_name = name; }
  59   inline void SetExtension(const wxString& ext) { m_extension = ext; }
  60   inline void SetType(long type) { m_type = type; }
  61   inline void SetMimeType(const wxString& type) { m_mime = type; }
  62   inline wxString GetName() const { return m_name; }
  63   inline wxString GetExtension() const { return m_extension; }
  64   inline long GetType() const { return m_type; }
  65   inline wxString GetMimeType() const { return m_mime; }
  66
  67 protected:
  68   wxString  m_name;
  69   wxString  m_extension;
  70   wxString  m_mime;
  71   long      m_type;
  72
  73 };
  74
  75 //-----------------------------------------------------------------------------
  76 // wxPNGHandler
  77 //-----------------------------------------------------------------------------
  78
  79 #if wxUSE_LIBPNG
  80 class WXDLLEXPORT wxPNGHandler: public wxImageHandler
  81 {
  82   DECLARE_DYNAMIC_CLASS(wxPNGHandler)
  83
  84 public:
  85
  86   inline wxPNGHandler()
  87   {
  88       m_name = "PNG file";
  89       m_extension = "png";
  90       m_type = wxBITMAP_TYPE_PNG;
  91       m_mime = "image/png";
  92   };
  93
  94 #if wxUSE_STREAMS
  95   virtual bool LoadFile( wxImage *image, wxInputStream& stream );
  96   virtual bool SaveFile( wxImage *image, wxOutputStream& stream );
  97 #endif
  98
  99 };
 100 #endif
 101
 102 //-----------------------------------------------------------------------------
 103 // wxJPEGHandler
 104 //-----------------------------------------------------------------------------
 105
 106 #if wxUSE_LIBJPEG
 107 class WXDLLEXPORT wxJPEGHandler: public wxImageHandler
 108 {
 109   DECLARE_DYNAMIC_CLASS(wxJPEGHandler)
 110
 111 public:
 112
 113   inline wxJPEGHandler()
 114   {
 115       m_name = "JPEG file";
 116       m_extension = "jpg";
 117       m_type = wxBITMAP_TYPE_JPEG;
 118       m_mime = "image/jpeg";
 119   };
 120
 121   virtual bool LoadFile( wxImage *image, wxInputStream& stream );
 122   virtual bool SaveFile( wxImage *image, wxOutputStream& stream );
 123 };
 124 #endif
 125
 126 //-----------------------------------------------------------------------------
 127 // wxBMPHandler
 128 //-----------------------------------------------------------------------------
 129
 130 class WXDLLEXPORT wxBMPHandler: public wxImageHandler
 131 {
 132   DECLARE_DYNAMIC_CLASS(wxBMPHandler)
 133
 134 public:
 135
 136   inline wxBMPHandler()
 137   {
 138       m_name = "BMP file";
 139       m_extension = "bmp";
 140       m_type = wxBITMAP_TYPE_BMP;
 141       m_mime = "image/bmp";
 142   };
 143
 144 #if wxUSE_STREAMS
 145   virtual bool LoadFile( wxImage *image, wxInputStream& stream );
 146 #endif
 147 };
 148
 149 //-----------------------------------------------------------------------------
 150 // wxImage
 151 //-----------------------------------------------------------------------------
 152
 153 class WXDLLEXPORT wxImage: public wxObject
 154 {
 155   DECLARE_DYNAMIC_CLASS(wxImage)
 156
 157   friend class WXDLLEXPORT wxImageHandler;
 158
 159 public:
 160
 161   wxImage();
 162   wxImage( int width, int height );
 163   wxImage( const wxString& name, long type = wxBITMAP_TYPE_PNG );
 164   wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_PNG );
 165   wxImage( const wxString& name, const wxString& mimetype );
 166   wxImage( wxInputStream& stream, const wxString& mimetype );
 167
 168   wxImage( const wxImage& image );
 169   wxImage( const wxImage* image );
 170
 171   // these functions get implemented in /src/(platform)/bitmap.cpp
 172   wxImage( const wxBitmap &bitmap );
 173   wxBitmap ConvertToBitmap() const;
 174
 175   void Create( int width, int height );
 176   void Destroy();
 177
 178   wxImage Scale( int width, int height );
 179
 180   // these routines are slow but safe
 181   void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b );
 182   unsigned char GetRed( int x, int y );
 183   unsigned char GetGreen( int x, int y );
 184   unsigned char GetBlue( int x, int y );
 185
 186   virtual bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_PNG );
 187   virtual bool LoadFile( const wxString& name, const wxString& mimetype );
 188
 189 #if wxUSE_STREAMS
 190   virtual bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_PNG );
 191   virtual bool LoadFile( wxInputStream& stream, const wxString& mimetype );
 192 #endif
 193
 194   virtual bool SaveFile( const wxString& name, int type );
 195   virtual bool SaveFile( const wxString& name, const wxString& mimetype );
 196
 197 #if wxUSE_STREAMS
 198   virtual bool SaveFile( wxOutputStream& stream, int type );
 199   virtual bool SaveFile( wxOutputStream& stream, const wxString& mimetype );
 200 #endif
 201
 202   bool Ok() const;
 203   int GetWidth() const;
 204   int GetHeight() const;
 205
 206   char unsigned *GetData() const;
 207   void SetData( char unsigned *data );
 208
 209   void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );
 210   unsigned char GetMaskRed() const;
 211   unsigned char GetMaskGreen() const;
 212   unsigned char GetMaskBlue() const;
 213   void SetMask( bool mask = TRUE );
 214   bool HasMask() const;
 215
 216   inline wxImage& operator = (const wxImage& image)
 217     { if ((*this) == image)
 218           return (*this);
 219       Ref(image);
 220       return *this; }
 221
 222   inline bool operator == (const wxImage& image)
 223     { return m_refData == image.m_refData; }
 224   inline bool operator != (const wxImage& image)
 225     { return m_refData != image.m_refData; }
 226
 227   static inline wxList& GetHandlers() { return sm_handlers; }
 228   static void AddHandler( wxImageHandler *handler );
 229   static void InsertHandler( wxImageHandler *handler );
 230   static bool RemoveHandler( const wxString& name );
 231   static wxImageHandler *FindHandler( const wxString& name );
 232   static wxImageHandler *FindHandler( const wxString& extension, long imageType );
 233   static wxImageHandler *FindHandler( long imageType );
 234   static wxImageHandler *FindHandlerMime( const wxString& mimetype );
 235
 236   static void CleanUpHandlers();
 237   static void InitStandardHandlers();
 238
 239 protected:
 240
 241   static wxList sm_handlers;
 242
 243 };
 244
 245 #endif
 246   // _WX_IMAGE_H_
 247