include/wx/gtk1/bitmap.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  15 #pragma interface
  16 #endif
  17
  18 #include "wx/defs.h"
  19 #include "wx/object.h"
  20 #include "wx/string.h"
  21 #include "wx/palette.h"
  22 #include "wx/gdiobj.h"
  23
  24 #ifdef __WXGTK20__
  25 typedef struct _GdkPixbuf GdkPixbuf;
  26 #endif
  27
  28 //-----------------------------------------------------------------------------
  29 // classes
  30 //-----------------------------------------------------------------------------
  31
  32 class wxMask;
  33 class wxBitmap;
  34 class wxImage;
  35
  36 //-----------------------------------------------------------------------------
  37 // wxMask
  38 //-----------------------------------------------------------------------------
  39
  40 class wxMask: public wxObject
  41 {
  42 public:
  43     wxMask();
  44     wxMask( const wxBitmap& bitmap, const wxColour& colour );
  45     wxMask( const wxBitmap& bitmap, int paletteIndex );
  46     wxMask( const wxBitmap& bitmap );
  47     ~wxMask();
  48
  49     bool Create( const wxBitmap& bitmap, const wxColour& colour );
  50     bool Create( const wxBitmap& bitmap, int paletteIndex );
  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 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 #ifdef __WXGTK20__
 120     void SetPixbuf(GdkPixbuf *pixbuf);
 121 #endif
 122
 123     GdkPixmap *GetPixmap() const;
 124     GdkBitmap *GetBitmap() const;
 125     bool HasPixmap() const;
 126 #ifdef __WXGTK20__
 127     bool HasPixbuf() const;
 128     GdkPixbuf *GetPixbuf() const;
 129 #endif
 130
 131     // Basically, this corresponds to Win32 StretchBlt()
 132     wxBitmap Rescale( int clipx, int clipy, int clipwidth, int clipheight, int width, int height );
 133 protected:
 134     bool CreateFromXpm(const char **bits);
 135     bool CreateFromImage(const wxImage& image, int depth);
 136
 137 private:
 138     // to be called from CreateFromImage only!
 139     bool CreateFromImageAsBitmap(const wxImage& image);
 140     bool CreateFromImageAsPixmap(const wxImage& image);
 141
 142 #ifdef __WXGTK20__
 143     bool CreateFromImageAsPixbuf(const wxImage& image);
 144
 145     enum Representation
 146     {
 147         Pixmap,
 148         Pixbuf
 149     };
 150     // removes other representations from memory, keeping only 'keep'
 151     // (wxBitmap may keep same bitmap e.g. as both pixmap and pixbuf):
 152     void PurgeOtherRepresentations(Representation keep);
 153
 154     friend class wxMemoryDC;
 155 #endif
 156     friend class wxBitmapHandler;
 157
 158 private:
 159     DECLARE_DYNAMIC_CLASS(wxBitmap)
 160 };
 161
 162 //-----------------------------------------------------------------------------
 163 // wxBitmapHandler
 164 //-----------------------------------------------------------------------------
 165
 166 class wxBitmapHandler: public wxBitmapHandlerBase
 167 {
 168 public:
 169     wxBitmapHandler() { }
 170     virtual ~wxBitmapHandler();
 171
 172     virtual bool Create(wxBitmap *bitmap, void *data, long flags, int width, int height, int depth = 1);
 173     virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
 174         int desiredWidth, int desiredHeight);
 175     virtual bool SaveFile(const wxBitmap *bitmap, const wxString& name, int type, const wxPalette *palette = NULL);
 176
 177 private:
 178     DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
 179 };
 180
 181
 182 #endif // __GTKBITMAPH__