include/wx/gtk/bitmap.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/gtk/bitmap.h
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10
  11 #ifndef __GTKBITMAPH__
  12 #define __GTKBITMAPH__
  13
  14 #include "wx/defs.h"
  15 #include "wx/object.h"
  16 #include "wx/string.h"
  17 #include "wx/palette.h"
  18 #include "wx/gdiobj.h"
  19
  20 typedef struct _GdkPixbuf GdkPixbuf;
  21
  22 class WXDLLEXPORT wxPixelDataBase;
  23
  24 //-----------------------------------------------------------------------------
  25 // classes
  26 //-----------------------------------------------------------------------------
  27
  28 class WXDLLIMPEXP_CORE wxMask;
  29 class WXDLLIMPEXP_CORE wxBitmap;
  30 class WXDLLIMPEXP_CORE wxImage;
  31
  32 //-----------------------------------------------------------------------------
  33 // wxMask
  34 //-----------------------------------------------------------------------------
  35
  36 class WXDLLIMPEXP_CORE wxMask: public wxObject
  37 {
  38 public:
  39     wxMask();
  40     wxMask( const wxBitmap& bitmap, const wxColour& colour );
  41 #if wxUSE_PALETTE
  42     wxMask( const wxBitmap& bitmap, int paletteIndex );
  43 #endif // wxUSE_PALETTE
  44     wxMask( const wxBitmap& bitmap );
  45     ~wxMask();
  46
  47     bool Create( const wxBitmap& bitmap, const wxColour& colour );
  48 #if wxUSE_PALETTE
  49     bool Create( const wxBitmap& bitmap, int paletteIndex );
  50 #endif // wxUSE_PALETTE
  51     bool Create( const wxBitmap& bitmap );
  52
  53     // implementation
  54     GdkBitmap   *m_bitmap;
  55
  56     GdkBitmap *GetBitmap() const;
  57
  58 private:
  59     DECLARE_DYNAMIC_CLASS(wxMask)
  60 };
  61
  62 //-----------------------------------------------------------------------------
  63 // wxBitmap
  64 //-----------------------------------------------------------------------------
  65
  66 class WXDLLIMPEXP_CORE wxBitmap: public wxBitmapBase
  67 {
  68 public:
  69     wxBitmap();
  70     wxBitmap( int width, int height, int depth = -1 );
  71     wxBitmap( const char bits[], int width, int height, int depth = 1 );
  72     wxBitmap( const char **bits ) { (void)CreateFromXpm(bits); }
  73     wxBitmap( char **bits ) { (void)CreateFromXpm((const char **)bits); }
  74     wxBitmap( const wxBitmap& bmp );
  75     wxBitmap( const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM );
  76     wxBitmap( const wxImage& image, int depth = -1 ) { (void)CreateFromImage(image, depth); }
  77     ~wxBitmap();
  78     wxBitmap& operator = ( const wxBitmap& bmp );
  79     bool operator == ( const wxBitmap& bmp ) const;
  80     bool operator != ( const wxBitmap& bmp ) const;
  81     bool Ok() const;
  82
  83     bool Create(int width, int height, int depth = -1);
  84
  85     int GetHeight() const;
  86     int GetWidth() const;
  87     int GetDepth() const;
  88
  89     wxImage ConvertToImage() const;
  90
  91     // copies the contents and mask of the given (colour) icon to the bitmap
  92     virtual bool CopyFromIcon(const wxIcon& icon);
  93
  94     wxMask *GetMask() const;
  95     void SetMask( wxMask *mask );
  96
  97     wxBitmap GetSubBitmap( const wxRect& rect ) const;
  98
  99     bool SaveFile(const wxString &name, wxBitmapType type,
 100                           const wxPalette *palette = (wxPalette *)NULL) const;
 101     bool LoadFile(const wxString &name, wxBitmapType type = wxBITMAP_TYPE_XPM );
 102
 103 #if wxUSE_PALETTE
 104     wxPalette *GetPalette() const;
 105     void SetPalette(const wxPalette& palette);
 106     wxPalette *GetColourMap() const { return GetPalette(); };
 107 #endif // wxUSE_PALETTE
 108
 109     static void InitStandardHandlers();
 110
 111     // implementation
 112     // --------------
 113
 114     void SetHeight( int height );
 115     void SetWidth( int width );
 116     void SetDepth( int depth );
 117     void SetPixmap( GdkPixmap *pixmap );
 118     void SetBitmap( GdkBitmap *bitmap );
 119     void SetPixbuf(GdkPixbuf *pixbuf);
 120
 121     GdkPixmap *GetPixmap() const;
 122     GdkBitmap *GetBitmap() const;
 123     bool HasPixmap() const;
 124     bool HasPixbuf() const;
 125     GdkPixbuf *GetPixbuf() const;
 126
 127     // Basically, this corresponds to Win32 StretchBlt()
 128     wxBitmap Rescale( int clipx, int clipy, int clipwidth, int clipheight, int width, int height );
 129
 130     // raw bitmap access support functions
 131     void *GetRawData(wxPixelDataBase& data, int bpp);
 132     void UngetRawData(wxPixelDataBase& data);
 133
 134     bool HasAlpha() const;
 135     void UseAlpha();
 136
 137 protected:
 138     bool CreateFromXpm(const char **bits);
 139     bool CreateFromImage(const wxImage& image, int depth);
 140
 141 private:
 142     // to be called from CreateFromImage only!
 143     bool CreateFromImageAsBitmap(const wxImage& image);
 144     bool CreateFromImageAsPixmap(const wxImage& image);
 145
 146     bool CreateFromImageAsPixbuf(const wxImage& image);
 147
 148     enum Representation
 149     {
 150         Pixmap,
 151         Pixbuf
 152     };
 153     // removes other representations from memory, keeping only 'keep'
 154     // (wxBitmap may keep same bitmap e.g. as both pixmap and pixbuf):
 155     void PurgeOtherRepresentations(Representation keep);
 156
 157     friend class wxMemoryDC;
 158     friend class wxBitmapHandler;
 159
 160 private:
 161     DECLARE_DYNAMIC_CLASS(wxBitmap)
 162 };
 163
 164 //-----------------------------------------------------------------------------
 165 // wxBitmapHandler
 166 //-----------------------------------------------------------------------------
 167
 168 class WXDLLIMPEXP_CORE wxBitmapHandler: public wxBitmapHandlerBase
 169 {
 170 public:
 171     wxBitmapHandler() { }
 172     virtual ~wxBitmapHandler();
 173
 174     virtual bool Create(wxBitmap *bitmap, void *data, long flags, int width, int height, int depth = 1);
 175     virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
 176         int desiredWidth, int desiredHeight);
 177     virtual bool SaveFile(const wxBitmap *bitmap, const wxString& name, int type, const wxPalette *palette = NULL);
 178
 179 private:
 180     DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
 181 };
 182
 183
 184 #endif // __GTKBITMAPH__