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