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:     wxWidgets licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_BITMAP_H_
  13 #define _WX_BITMAP_H_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16   #pragma interface "bitmap.h"
  17 #endif
  18
  19 #include "wx/palette.h"
  20
  21 // Bitmap
  22 class WXDLLEXPORT wxBitmap;
  23 class WXDLLEXPORT wxBitmapHandler;
  24 class WXDLLEXPORT wxControl;
  25 class WXDLLEXPORT wxCursor;
  26 class WXDLLEXPORT wxDC;
  27 class WXDLLEXPORT wxIcon;
  28 class WXDLLEXPORT wxImage;
  29 class WXDLLEXPORT wxPixelDataBase;
  30
  31 // A mask is a bitmap used for drawing bitmaps
  32 // it can be a monochrome bitmap or a multi-bit bitmap which transfers to alpha channels
  33 // transparently.
  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 bitmap and a palette index indicating
  47   // the transparent area
  48   wxMask(const wxBitmap& bitmap, int paletteIndex);
  49
  50   // Construct a mask from a mono bitmap (copies the bitmap).
  51   wxMask(const wxBitmap& bitmap);
  52
  53   ~wxMask();
  54
  55   bool Create(const wxBitmap& bitmap, const wxColour& colour);
  56   bool Create(const wxBitmap& bitmap, int paletteIndex);
  57   bool Create(const wxBitmap& bitmap);
  58
  59   // Implementation
  60   bool PointMasked(int x, int y);
  61   inline WXHBITMAP GetMaskBitmap() const { return m_maskBitmap; }
  62   inline void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; }
  63   int GetDepth() const { return m_depth ; }
  64   void SetDepth( int depth ) { m_depth = depth ; }
  65 protected:
  66   WXHBITMAP m_maskBitmap;
  67   int m_depth ;
  68 };
  69
  70 enum { kMacBitmapTypeUnknownType , kMacBitmapTypeGrafWorld, kMacBitmapTypePict , kMacBitmapTypeIcon } ;
  71
  72 class WXDLLEXPORT wxBitmapRefData: public wxGDIRefData
  73 {
  74     DECLARE_NO_COPY_CLASS(wxBitmapRefData)
  75
  76     friend class WXDLLEXPORT wxBitmap;
  77     friend class WXDLLEXPORT wxIcon;
  78     friend class WXDLLEXPORT wxCursor;
  79 public:
  80     wxBitmapRefData();
  81     ~wxBitmapRefData();
  82
  83 public:
  84   int           m_width;
  85   int           m_height;
  86   int           m_depth;
  87   bool          m_ok;
  88   int           m_numColors;
  89 #if wxUSE_PALETTE
  90   wxPalette     m_bitmapPalette;
  91 #endif // wxUSE_PALETTE
  92   int           m_quality;
  93
  94   int            m_bitmapType ;
  95   WXHMETAFILE    m_hPict ;
  96   WXHBITMAP     m_hBitmap;
  97   WXHICON       m_hIcon ;
  98   wxMask *      m_bitmapMask; // Optional mask
  99   bool          m_hasAlpha;
 100 };
 101
 102 #define M_BITMAPDATA ((wxBitmapRefData *)m_refData)
 103
 104 class WXDLLEXPORT wxBitmapHandler: public wxBitmapHandlerBase
 105 {
 106   DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
 107 public:
 108   wxBitmapHandler() : m_name(), m_extension(), m_type(0) { }
 109   virtual ~wxBitmapHandler();
 110
 111   virtual bool Create(wxBitmap *bitmap, void *data, long flags, int width, int height, int depth = 1);
 112   virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
 113       int desiredWidth, int desiredHeight);
 114   virtual bool SaveFile(const wxBitmap *bitmap, const wxString& name, int type, const wxPalette *palette = NULL);
 115
 116   void SetName(const wxString& name) { m_name = name; }
 117   void SetExtension(const wxString& ext) { m_extension = ext; }
 118   void SetType(long type) { m_type = type; }
 119   wxString GetName() const { return m_name; }
 120   wxString GetExtension() const { return m_extension; }
 121   long GetType() const { return m_type; }
 122
 123 protected:
 124   wxString  m_name;
 125   wxString  m_extension;
 126   long      m_type;
 127 };
 128
 129 #define M_BITMAPHANDLERDATA ((wxBitmapRefData *)bitmap->GetRefData())
 130
 131 class WXDLLEXPORT wxBitmap: public wxBitmapBase
 132 {
 133   DECLARE_DYNAMIC_CLASS(wxBitmap)
 134
 135   friend class WXDLLEXPORT wxBitmapHandler;
 136
 137 public:
 138   wxBitmap(); // Platform-specific
 139
 140   // Copy constructors
 141   wxBitmap(const wxBitmap& bitmap)
 142       : wxBitmapBase()
 143   { Ref(bitmap); }
 144
 145   // Initialize with raw data.
 146   wxBitmap(const char bits[], int width, int height, int depth = 1);
 147
 148   // Initialize with XPM data
 149   bool CreateFromXpm(const char **bits);
 150   wxBitmap(const char **bits);
 151   wxBitmap(char **bits);
 152
 153   // Load a file or resource
 154   wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_PICT_RESOURCE);
 155
 156   // Constructor for generalised creation from data
 157   wxBitmap(void *data, wxBitmapType type, int width, int height, int depth = 1);
 158
 159   // If depth is omitted, will create a bitmap compatible with the display
 160   wxBitmap(int width, int height, int depth = -1);
 161
 162   // Convert from wxImage:
 163   wxBitmap(const wxImage& image, int depth = -1);
 164
 165   ~wxBitmap();
 166
 167   wxImage ConvertToImage() const;
 168
 169   // get the given part of bitmap
 170   wxBitmap GetSubBitmap( const wxRect& rect ) const;
 171
 172   virtual bool Create(int width, int height, int depth = -1);
 173   virtual bool Create(void *data, wxBitmapType type, int width, int height, int depth = 1);
 174   virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
 175   virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
 176
 177   // copies the contents and mask of the given (colour) icon to the bitmap
 178   virtual bool CopyFromIcon(const wxIcon& icon);
 179
 180   bool Ok() const;
 181   int GetWidth() const;
 182   int GetHeight() const;
 183   int GetDepth() const;
 184   int GetQuality() const;
 185   void SetWidth(int w);
 186   void SetHeight(int h);
 187   void SetDepth(int d);
 188   void SetQuality(int q);
 189   void SetOk(bool isOk);
 190
 191 #if wxUSE_PALETTE
 192    wxPalette* GetPalette() const;
 193    void SetPalette(const wxPalette& palette);
 194 #endif // wxUSE_PALETTE
 195
 196   wxMask *GetMask() const;
 197   void SetMask(wxMask *mask) ;
 198
 199   int GetBitmapType() const;
 200
 201   inline wxBitmap& operator = (const wxBitmap& bitmap) { if (*this == bitmap) return (*this); Ref(bitmap); return *this; }
 202   inline bool operator == (const wxBitmap& bitmap) const { return m_refData == bitmap.m_refData; }
 203   inline bool operator != (const wxBitmap& bitmap) const { return m_refData != bitmap.m_refData; }
 204
 205   static void InitStandardHandlers();
 206
 207     // raw bitmap access support functions, for internal use only
 208     void *GetRawData(wxPixelDataBase& data, int bpp);
 209     void UngetRawData(wxPixelDataBase& data);
 210
 211     void UseAlpha();
 212
 213 public:
 214   WXHBITMAP GetHBITMAP() const;
 215   inline WXHICON GetHICON() const { return (M_BITMAPDATA ? M_BITMAPDATA->m_hIcon : 0); }
 216   WXHMETAFILE GetPict(bool *created = NULL ) const;
 217
 218   void SetHBITMAP(WXHBITMAP bmp);
 219   void SetHICON(WXHICON ico);
 220   void SetPict( WXHMETAFILE pict ) ;
 221
 222   bool FreeResource(bool force = FALSE);
 223 };
 224 #endif
 225   // _WX_BITMAP_H_