include/wx/gtk1/bitmap.h

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