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