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