include/wx/mac/carbon/bitmap.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        bitmap.h
   3 // Purpose:     wxBitmap class
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // Created:     1998-01-01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Stefan Csomor
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_BITMAP_H_
  13 #define _WX_BITMAP_H_
  14
  15 #include "wx/palette.h"
  16
  17 // Bitmap
  18 class WXDLLEXPORT wxBitmap;
  19 class wxBitmapRefData ;
  20 class WXDLLEXPORT wxBitmapHandler;
  21 class WXDLLEXPORT wxControl;
  22 class WXDLLEXPORT wxCursor;
  23 class WXDLLEXPORT wxDC;
  24 class WXDLLEXPORT wxIcon;
  25 class WXDLLEXPORT wxImage;
  26 class WXDLLEXPORT wxPixelDataBase;
  27
  28 // A mask is a bitmap used for drawing bitmaps
  29 // Internally it is stored as a 8 bit deep memory chunk, 0 = black means the source will be drawn
  30 // 255 = white means the source will not be drawn, no other values will be present
  31 // 8 bit is chosen only for performance reasons, note also that this is the inverse value range
  32 // from alpha, where 0 = invisible , 255 = fully drawn
  33
  34 class WXDLLEXPORT wxMask: public wxObject
  35 {
  36     DECLARE_DYNAMIC_CLASS(wxMask)
  37     DECLARE_NO_COPY_CLASS(wxMask)
  38
  39 public:
  40     wxMask();
  41
  42     // Construct a mask from a bitmap and a colour indicating
  43     // the transparent area
  44     wxMask(const wxBitmap& bitmap, const wxColour& colour);
  45
  46     // Construct a mask from a mono bitmap (black meaning show pixels, white meaning transparent)
  47     wxMask(const wxBitmap& bitmap);
  48
  49     // implementation helper only : construct a mask from a 32 bit memory buffer
  50     wxMask(const wxMemoryBuffer& buf, int width , int height , int bytesPerRow ) ;
  51
  52     virtual ~wxMask();
  53
  54     bool Create(const wxBitmap& bitmap, const wxColour& colour);
  55     bool Create(const wxBitmap& bitmap);
  56     bool Create(const wxMemoryBuffer& buf, int width , int height , int bytesPerRow ) ;
  57
  58     // Implementation below
  59
  60     void Init() ;
  61
  62     // a 8 bit depth mask
  63     void* GetRawAccess() const;
  64     int GetBytesPerRow() const { return m_bytesPerRow ; }
  65     // renders/updates native representation when necessary
  66     void RealizeNative() ;
  67
  68     WXHBITMAP GetHBITMAP() const ;
  69
  70
  71 private:
  72     wxMemoryBuffer m_memBuf ;
  73     int m_bytesPerRow ;
  74     int m_width ;
  75     int m_height ;
  76
  77     WXHBITMAP m_maskBitmap ;
  78
  79 };
  80
  81 class WXDLLIMPEXP_CORE wxBitmapHandler: public wxBitmapHandlerBase
  82 {
  83     DECLARE_ABSTRACT_CLASS(wxBitmapHandler)
  84 };
  85
  86 class WXDLLEXPORT wxBitmap: public wxBitmapBase
  87 {
  88     DECLARE_DYNAMIC_CLASS(wxBitmap)
  89
  90     friend class WXDLLEXPORT wxBitmapHandler;
  91
  92 public:
  93     wxBitmap(); // Platform-specific
  94
  95     // Initialize with raw data.
  96     wxBitmap(const char bits[], int width, int height, int depth = 1);
  97
  98     // Initialize with XPM data
  99     wxBitmap(const char* const* bits);
 100
 101     // Load a file or resource
 102     wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_PICT_RESOURCE);
 103
 104     // Constructor for generalised creation from data
 105     wxBitmap(const void* data, wxBitmapType type, int width, int height, int depth = 1);
 106
 107     // If depth is omitted, will create a bitmap compatible with the display
 108     wxBitmap(int width, int height, int depth = -1);
 109
 110     // Convert from wxImage:
 111     wxBitmap(const wxImage& image, int depth = -1);
 112
 113     // Convert from wxIcon
 114     wxBitmap(const wxIcon& icon) { CopyFromIcon(icon); }
 115
 116     virtual ~wxBitmap();
 117
 118     wxImage ConvertToImage() const;
 119
 120     // get the given part of bitmap
 121     wxBitmap GetSubBitmap( const wxRect& rect ) const;
 122
 123     virtual bool Create(int width, int height, int depth = -1);
 124     virtual bool Create(const void* data, wxBitmapType type, int width, int height, int depth = 1);
 125     // virtual bool Create( WXHICON icon) ;
 126     virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
 127     virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
 128
 129     wxBitmapRefData *GetBitmapData() const
 130         { return (wxBitmapRefData *)m_refData; }
 131
 132     // copies the contents and mask of the given (colour) icon to the bitmap
 133     virtual bool CopyFromIcon(const wxIcon& icon);
 134
 135     bool Ok() const { return IsOk(); }
 136     bool IsOk() const;
 137     int GetWidth() const;
 138     int GetHeight() const;
 139     int GetDepth() const;
 140     void SetWidth(int w);
 141     void SetHeight(int h);
 142     void SetDepth(int d);
 143     void SetOk(bool isOk);
 144
 145 #if WXWIN_COMPATIBILITY_2_4
 146     // these functions do nothing and are only there for backwards
 147     // compatibility
 148     wxDEPRECATED( int GetQuality() const );
 149     wxDEPRECATED( void SetQuality(int quality) );
 150 #endif // WXWIN_COMPATIBILITY_2_4
 151
 152 #if wxUSE_PALETTE
 153     wxPalette* GetPalette() const;
 154     void SetPalette(const wxPalette& palette);
 155 #endif // wxUSE_PALETTE
 156
 157     wxMask *GetMask() const;
 158     void SetMask(wxMask *mask) ;
 159
 160     inline bool operator == (const wxBitmap& bitmap) const { return m_refData == bitmap.m_refData; }
 161     inline bool operator != (const wxBitmap& bitmap) const { return m_refData != bitmap.m_refData; }
 162
 163     static void InitStandardHandlers();
 164
 165     // raw bitmap access support functions, for internal use only
 166     void *GetRawData(wxPixelDataBase& data, int bpp);
 167     void UngetRawData(wxPixelDataBase& data);
 168
 169     // these functions are internal and shouldn't be used, they risk to
 170     // disappear in the future
 171     bool HasAlpha() const;
 172     void UseAlpha();
 173
 174     // returns the 'native' implementation, a GWorldPtr for the content and one for the mask
 175     WXHBITMAP GetHBITMAP( WXHBITMAP * mask = NULL ) const;
 176
 177 #ifdef __WXMAC_OSX__
 178     // returns a CGImageRef which must released after usage with CGImageRelease
 179     WXCGIMAGEREF CGImageCreate() const ;
 180 #endif
 181     // get read only access to the underlying buffer
 182     void *GetRawAccess() const ;
 183     // brackets to the underlying OS structure for read/write access
 184     // makes sure that no cached images will be constructed until terminated
 185     void *BeginRawAccess() ;
 186     void EndRawAccess() ;
 187 };
 188 #endif
 189   // _WX_BITMAP_H_