include/wx/mac/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 #if defined(__GNUG__) && !defined(__APPLE__)
  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   wxPalette     m_bitmapPalette;
  90   int           m_quality;
  91
  92   int            m_bitmapType ;
  93   WXHMETAFILE    m_hPict ;
  94   WXHBITMAP     m_hBitmap;
  95   WXHICON       m_hIcon ;
  96   wxMask *      m_bitmapMask; // Optional mask
  97 };
  98
  99 #define M_BITMAPDATA ((wxBitmapRefData *)m_refData)
 100
 101 class WXDLLEXPORT wxBitmapHandler: public wxBitmapHandlerBase
 102 {
 103   DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
 104 public:
 105   wxBitmapHandler() : m_name(), m_extension(), m_type(0) { }
 106   virtual ~wxBitmapHandler();
 107
 108   virtual bool Create(wxBitmap *bitmap, void *data, long flags, int width, int height, int depth = 1);
 109   virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
 110       int desiredWidth, int desiredHeight);
 111   virtual bool SaveFile(const wxBitmap *bitmap, const wxString& name, int type, const wxPalette *palette = NULL);
 112
 113   void SetName(const wxString& name) { m_name = name; }
 114   void SetExtension(const wxString& ext) { m_extension = ext; }
 115   void SetType(long type) { m_type = type; }
 116   wxString GetName() const { return m_name; }
 117   wxString GetExtension() const { return m_extension; }
 118   long GetType() const { return m_type; }
 119
 120 protected:
 121   wxString  m_name;
 122   wxString  m_extension;
 123   long      m_type;
 124 };
 125
 126 #define M_BITMAPHANDLERDATA ((wxBitmapRefData *)bitmap->GetRefData())
 127
 128 class WXDLLEXPORT wxBitmap: public wxBitmapBase
 129 {
 130   DECLARE_DYNAMIC_CLASS(wxBitmap)
 131
 132   friend class WXDLLEXPORT wxBitmapHandler;
 133
 134 public:
 135   wxBitmap(); // Platform-specific
 136
 137   // Copy constructors
 138   wxBitmap(const wxBitmap& bitmap)
 139       : wxBitmapBase()
 140   { Ref(bitmap); }
 141
 142   // Initialize with raw data.
 143   wxBitmap(const char bits[], int width, int height, int depth = 1);
 144
 145   // Initialize with XPM data
 146   bool CreateFromXpm(const char **bits);
 147   wxBitmap(const char **bits);
 148   wxBitmap(char **bits);
 149
 150   // Load a file or resource
 151   wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_PICT_RESOURCE);
 152
 153   // Constructor for generalised creation from data
 154   wxBitmap(void *data, wxBitmapType type, int width, int height, int depth = 1);
 155
 156   // If depth is omitted, will create a bitmap compatible with the display
 157   wxBitmap(int width, int height, int depth = -1);
 158
 159   // Convert from wxImage:
 160   wxBitmap(const wxImage& image, int depth = -1);
 161
 162   ~wxBitmap();
 163
 164   wxImage ConvertToImage() const;
 165
 166   // get the given part of bitmap
 167   wxBitmap GetSubBitmap( const wxRect& rect ) const;
 168
 169   virtual bool Create(int width, int height, int depth = -1);
 170   virtual bool Create(void *data, wxBitmapType type, int width, int height, int depth = 1);
 171   virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
 172   virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
 173
 174   // copies the contents and mask of the given (colour) icon to the bitmap
 175   virtual bool CopyFromIcon(const wxIcon& icon);
 176
 177   bool Ok() const;
 178   int GetWidth() const;
 179   int GetHeight() const;
 180   int GetDepth() const;
 181   int GetQuality() const;
 182   void SetWidth(int w);
 183   void SetHeight(int h);
 184   void SetDepth(int d);
 185   void SetQuality(int q);
 186   void SetOk(bool isOk);
 187
 188   wxPalette* GetPalette() const;
 189   void SetPalette(const wxPalette& palette);
 190
 191   wxMask *GetMask() const;
 192   void SetMask(wxMask *mask) ;
 193
 194   int GetBitmapType() const;
 195
 196   inline wxBitmap& operator = (const wxBitmap& bitmap) { if (*this == bitmap) return (*this); Ref(bitmap); return *this; }
 197   inline bool operator == (const wxBitmap& bitmap) const { return m_refData == bitmap.m_refData; }
 198   inline bool operator != (const wxBitmap& bitmap) const { return m_refData != bitmap.m_refData; }
 199
 200   static void InitStandardHandlers();
 201
 202     // raw bitmap access support functions
 203     void *GetRawData(wxPixelDataBase& data, int bpp);
 204     void UngetRawData(wxPixelDataBase& data);
 205
 206     void UseAlpha();
 207
 208 public:
 209   WXHBITMAP GetHBITMAP() const;
 210   inline WXHICON GetHICON() const { return (M_BITMAPDATA ? M_BITMAPDATA->m_hIcon : 0); }
 211   WXHMETAFILE GetPict(bool *created = NULL ) const;
 212
 213   void SetHBITMAP(WXHBITMAP bmp);
 214   void SetHICON(WXHICON ico);
 215   void SetPict( WXHMETAFILE pict ) ;
 216
 217   bool FreeResource(bool force = FALSE);
 218 };
 219 #endif
 220   // _WX_BITMAP_H_