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 #ifdef wxNEEDS_CHARPP
  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 Ok() const { return IsOk(); }
  68     bool IsOk() const;
  69
  70     bool Create(int width, int height, int depth = -1);
  71
  72     int GetHeight() const;
  73     int GetWidth() const;
  74     int GetDepth() const;
  75
  76     wxImage ConvertToImage() const;
  77
  78     // copies the contents and mask of the given (colour) icon to the bitmap
  79     virtual bool CopyFromIcon(const wxIcon& icon);
  80
  81     wxMask *GetMask() const;
  82     void SetMask( wxMask *mask );
  83
  84     wxBitmap GetSubBitmap( const wxRect& rect ) const;
  85
  86     bool SaveFile(const wxString &name, wxBitmapType type,
  87                           const wxPalette *palette = (wxPalette *)NULL) const;
  88     bool LoadFile(const wxString &name, wxBitmapType type = wxBITMAP_TYPE_XPM );
  89
  90 #if wxUSE_PALETTE
  91     wxPalette *GetPalette() const;
  92     void SetPalette(const wxPalette& palette);
  93     wxPalette *GetColourMap() const { return GetPalette(); };
  94 #endif // wxUSE_PALETTE
  95
  96     static void InitStandardHandlers();
  97
  98     // implementation
  99     // --------------
 100
 101     void SetHeight( int height );
 102     void SetWidth( int width );
 103     void SetDepth( int depth );
 104     void SetPixmap( GdkPixmap *pixmap );
 105     void SetPixbuf(GdkPixbuf* pixbuf, int depth = 0);
 106
 107     GdkPixmap *GetPixmap() const;
 108     bool HasPixmap() const;
 109     bool HasPixbuf() const;
 110     GdkPixbuf *GetPixbuf() const;
 111
 112     // Basically, this corresponds to Win32 StretchBlt()
 113     wxBitmap Rescale(int clipx, int clipy, int clipwidth, int clipheight, int width, int height) const;
 114
 115     // raw bitmap access support functions
 116     void *GetRawData(wxPixelDataBase& data, int bpp);
 117     void UngetRawData(wxPixelDataBase& data);
 118
 119     bool HasAlpha() const;
 120     void UseAlpha();
 121
 122 protected:
 123     bool CreateFromImage(const wxImage& image, int depth);
 124
 125     virtual wxObjectRefData* CreateRefData() const;
 126     virtual wxObjectRefData* CloneRefData(const wxObjectRefData* data) const;
 127
 128 private:
 129     // to be called from CreateFromImage only!
 130     bool CreateFromImageAsPixmap(const wxImage& image, int depth);
 131     bool CreateFromImageAsPixbuf(const wxImage& image);
 132
 133     enum Representation
 134     {
 135         Pixmap,
 136         Pixbuf
 137     };
 138     // removes other representations from memory, keeping only 'keep'
 139     // (wxBitmap may keep same bitmap e.g. as both pixmap and pixbuf):
 140     void PurgeOtherRepresentations(Representation keep);
 141
 142     friend class wxMemoryDC;
 143     friend class wxBitmapHandler;
 144
 145 private:
 146     DECLARE_DYNAMIC_CLASS(wxBitmap)
 147 };
 148
 149 //-----------------------------------------------------------------------------
 150 // wxBitmapHandler
 151 //-----------------------------------------------------------------------------
 152
 153 class WXDLLIMPEXP_CORE wxBitmapHandler: public wxBitmapHandlerBase
 154 {
 155     DECLARE_ABSTRACT_CLASS(wxBitmapHandler)
 156 };
 157
 158 #endif // _WX_GTK_BITMAP_H_