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* const* bits );
  71     wxBitmap( const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM );
  72     wxBitmap( const wxImage& image, int depth = -1 ) { (void)CreateFromImage(image, depth); }
  73     virtual ~wxBitmap();
  74     bool operator == ( const wxBitmap& bmp ) const;
  75     bool operator != ( const wxBitmap& bmp ) const;
  76     bool Ok() const;
  77
  78     bool Create(int width, int height, int depth = -1);
  79
  80     int GetHeight() const;
  81     int GetWidth() const;
  82     int GetDepth() const;
  83
  84     wxImage ConvertToImage() const;
  85
  86     // copies the contents and mask of the given (colour) icon to the bitmap
  87     virtual bool CopyFromIcon(const wxIcon& icon);
  88
  89     wxMask *GetMask() const;
  90     void SetMask( wxMask *mask );
  91
  92     wxBitmap GetSubBitmap( const wxRect& rect ) const;
  93
  94     bool SaveFile(const wxString &name, wxBitmapType type,
  95                           const wxPalette *palette = (wxPalette *)NULL) const;
  96     bool LoadFile(const wxString &name, wxBitmapType type = wxBITMAP_TYPE_XPM );
  97
  98 #if wxUSE_PALETTE
  99     wxPalette *GetPalette() const;
 100     void SetPalette(const wxPalette& palette);
 101     wxPalette *GetColourMap() const { return GetPalette(); };
 102 #endif // wxUSE_PALETTE
 103
 104     static void InitStandardHandlers();
 105
 106     // implementation
 107     // --------------
 108
 109     void SetHeight( int height );
 110     void SetWidth( int width );
 111     void SetDepth( int depth );
 112     void SetPixmap( GdkPixmap *pixmap );
 113     void SetBitmap( GdkBitmap *bitmap );
 114
 115     GdkPixmap *GetPixmap() const;
 116     GdkBitmap *GetBitmap() const;
 117     bool HasPixmap() const;
 118
 119     // Basically, this corresponds to Win32 StretchBlt()
 120     wxBitmap Rescale( int clipx, int clipy, int clipwidth, int clipheight, int width, int height );
 121
 122     // raw bitmap access support functions
 123     void *GetRawData(wxPixelDataBase& data, int bpp);
 124     void UngetRawData(wxPixelDataBase& data);
 125
 126     bool HasAlpha() const;
 127     void UseAlpha();
 128
 129 protected:
 130     bool CreateFromImage(const wxImage& image, int depth);
 131
 132 private:
 133     // to be called from CreateFromImage only!
 134     bool CreateFromImageAsBitmap(const wxImage& image);
 135     bool CreateFromImageAsPixmap(const wxImage& image);
 136
 137     friend class wxBitmapHandler;
 138
 139 private:
 140     DECLARE_DYNAMIC_CLASS(wxBitmap)
 141 };
 142
 143 //-----------------------------------------------------------------------------
 144 // wxBitmapHandler
 145 //-----------------------------------------------------------------------------
 146
 147 class WXDLLIMPEXP_CORE wxBitmapHandler: public wxBitmapHandlerBase
 148 {
 149     DECLARE_ABSTRACT_CLASS(wxBitmapHandler)
 150 };
 151
 152 #endif // __GTKBITMAPH__