include/wx/mac/bitmap.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        bitmap.h
   3 // Purpose:     wxBitmap class
   4 // Author:      AUTHOR
   5 // Modified by:
   6 // Created:     ??/??/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) AUTHOR
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_BITMAP_H_
  13 #define _WX_BITMAP_H_
  14
  15 #ifdef __GNUG__
  16 #pragma interface "bitmap.h"
  17 #endif
  18
  19 #include "wx/gdiobj.h"
  20 #include "wx/gdicmn.h"
  21 #include "wx/palette.h"
  22
  23 // Bitmap
  24 class WXDLLEXPORT wxDC;
  25 class WXDLLEXPORT wxControl;
  26 class WXDLLEXPORT wxBitmap;
  27 class WXDLLEXPORT wxBitmapHandler;
  28 class WXDLLEXPORT wxIcon;
  29 class WXDLLEXPORT wxCursor;
  30 class WXDLLEXPORT wxImage;
  31
  32 GWorldPtr       wxMacCreateGWorld( int width , int height , int depth ) ;
  33 void            wxMacDestroyGWorld( GWorldPtr gw ) ;
  34 PicHandle       wxMacCreatePict( GWorldPtr gw , GWorldPtr mask = NULL ) ;
  35 void            wxMacSetColorTableEntry( CTabHandle newColors , int index , int red , int green ,  int blue ) ;
  36 CTabHandle      wxMacCreateColorTable( int numColors ) ;
  37
  38 // A mask is a mono bitmap used for drawing bitmaps
  39 // transparently.
  40 class WXDLLEXPORT wxMask: public wxObject
  41 {
  42   DECLARE_DYNAMIC_CLASS(wxMask)
  43
  44 public:
  45   wxMask();
  46
  47   // Construct a mask from a bitmap and a colour indicating
  48   // the transparent area
  49   wxMask(const wxBitmap& bitmap, const wxColour& colour);
  50
  51   // Construct a mask from a bitmap and a palette index indicating
  52   // the transparent area
  53   wxMask(const wxBitmap& bitmap, int paletteIndex);
  54
  55   // Construct a mask from a mono bitmap (copies the bitmap).
  56   wxMask(const wxBitmap& bitmap);
  57
  58   ~wxMask();
  59
  60   bool Create(const wxBitmap& bitmap, const wxColour& colour);
  61   bool Create(const wxBitmap& bitmap, int paletteIndex);
  62   bool Create(const wxBitmap& bitmap);
  63
  64   // Implementation
  65   bool PointMasked(int x, int y);
  66   inline WXHBITMAP GetMaskBitmap() const { return m_maskBitmap; }
  67   inline void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; }
  68 protected:
  69   WXHBITMAP m_maskBitmap;
  70 };
  71
  72 enum { kMacBitmapTypeUnknownType , kMacBitmapTypeGrafWorld, kMacBitmapTypePict , kMacBitmapTypeIcon } ;
  73
  74 class WXDLLEXPORT wxBitmapRefData: public wxGDIRefData
  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         PicHandle                       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 #ifdef __WXMAC_X__
 107   virtual ~wxBitmapHandler() {}  // Added min for Mac X
 108 #endif
 109
 110   virtual bool Create(wxBitmap *bitmap, void *data, long flags, int width, int height, int depth = 1);
 111   virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
 112       int desiredWidth, int desiredHeight);
 113   virtual bool SaveFile(const wxBitmap *bitmap, const wxString& name, int type, const wxPalette *palette = NULL);
 114
 115   inline void SetName(const wxString& name) { m_name = name; }
 116   inline void SetExtension(const wxString& ext) { m_extension = ext; }
 117   inline void SetType(long type) { m_type = type; }
 118   inline wxString GetName() const { return m_name; }
 119   inline wxString GetExtension() const { return m_extension; }
 120   inline long GetType() const { return m_type; }
 121 protected:
 122   wxString  m_name;
 123   wxString  m_extension;
 124   long      m_type;
 125 };
 126
 127 #define M_BITMAPHANDLERDATA ((wxBitmapRefData *)bitmap->GetRefData())
 128
 129 class WXDLLEXPORT wxBitmap: public wxBitmapBase
 130 {
 131   DECLARE_DYNAMIC_CLASS(wxBitmap)
 132
 133   friend class WXDLLEXPORT wxBitmapHandler;
 134
 135 public:
 136   wxBitmap(); // Platform-specific
 137
 138   // Copy constructors
 139   inline wxBitmap(const wxBitmap& bitmap)
 140   { Ref(bitmap); if ( wxTheBitmapList ) wxTheBitmapList->AddBitmap(this); }
 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) { return m_refData == bitmap.m_refData; }
 198   inline bool operator != (const wxBitmap& bitmap) { return m_refData != bitmap.m_refData; }
 199
 200   // Format handling
 201   static inline wxList& GetHandlers() { return sm_handlers; }
 202   static void AddHandler(wxBitmapHandler *handler);
 203   static void InsertHandler(wxBitmapHandler *handler);
 204   static bool RemoveHandler(const wxString& name);
 205   static wxBitmapHandler *FindHandler(const wxString& name);
 206   static wxBitmapHandler *FindHandler(const wxString& extension, wxBitmapType type);
 207   static wxBitmapHandler *FindHandler(wxBitmapType type);
 208
 209   static void InitStandardHandlers();
 210   static void CleanUpHandlers();
 211 protected:
 212   static wxList sm_handlers;
 213
 214   // TODO: Implementation
 215 public:
 216   void SetHBITMAP(WXHBITMAP bmp);
 217   WXHBITMAP GetHBITMAP() const;
 218   void SetHICON(WXHICON ico);
 219   inline WXHICON GetHICON() const { return (M_BITMAPDATA ? M_BITMAPDATA->m_hIcon : 0); }
 220
 221   PicHandle GetPict() const;
 222
 223   bool FreeResource(bool force = FALSE);
 224 };
 225 #endif
 226   // _WX_BITMAP_H_