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/palette.h"
  20
  21 // Bitmap
  22 class WXDLLEXPORT wxDC;
  23 class WXDLLEXPORT wxControl;
  24 class WXDLLEXPORT wxBitmap;
  25 class WXDLLEXPORT wxBitmapHandler;
  26 class WXDLLEXPORT wxIcon;
  27 class WXDLLEXPORT wxCursor;
  28 class WXDLLEXPORT wxImage;
  29
  30 GWorldPtr       wxMacCreateGWorld( int width , int height , int depth ) ;
  31 void                wxMacDestroyGWorld( GWorldPtr gw ) ;
  32 PicHandle       wxMacCreatePict( GWorldPtr gw , GWorldPtr mask = NULL ) ;
  33 CIconHandle wxMacCreateCIcon(GWorldPtr image , GWorldPtr mask , short dstDepth , short iconSize  ) ;
  34 void                wxMacSetColorTableEntry( CTabHandle newColors , int index , int red , int green ,  int blue ) ;
  35 CTabHandle      wxMacCreateColorTable( int numColors ) ;
  36
  37 // A mask is a mono bitmap used for drawing bitmaps
  38 // transparently.
  39 class WXDLLEXPORT wxMask: public wxObject
  40 {
  41   DECLARE_DYNAMIC_CLASS(wxMask)
  42
  43 public:
  44   wxMask();
  45
  46   // Construct a mask from a bitmap and a colour indicating
  47   // the transparent area
  48   wxMask(const wxBitmap& bitmap, const wxColour& colour);
  49
  50   // Construct a mask from a bitmap and a palette index indicating
  51   // the transparent area
  52   wxMask(const wxBitmap& bitmap, int paletteIndex);
  53
  54   // Construct a mask from a mono bitmap (copies the bitmap).
  55   wxMask(const wxBitmap& bitmap);
  56
  57   ~wxMask();
  58
  59   bool Create(const wxBitmap& bitmap, const wxColour& colour);
  60   bool Create(const wxBitmap& bitmap, int paletteIndex);
  61   bool Create(const wxBitmap& bitmap);
  62
  63   // Implementation
  64   bool PointMasked(int x, int y);
  65   inline WXHBITMAP GetMaskBitmap() const { return m_maskBitmap; }
  66   inline void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; }
  67 protected:
  68   WXHBITMAP m_maskBitmap;
  69 };
  70
  71 enum { kMacBitmapTypeUnknownType , kMacBitmapTypeGrafWorld, kMacBitmapTypePict , kMacBitmapTypeIcon } ;
  72
  73 class WXDLLEXPORT wxBitmapRefData: public wxGDIRefData
  74 {
  75     friend class WXDLLEXPORT wxBitmap;
  76     friend class WXDLLEXPORT wxIcon;
  77     friend class WXDLLEXPORT wxCursor;
  78 public:
  79     wxBitmapRefData();
  80     ~wxBitmapRefData();
  81
  82 public:
  83   int           m_width;
  84   int           m_height;
  85   int           m_depth;
  86   bool          m_ok;
  87   int           m_numColors;
  88   wxPalette     m_bitmapPalette;
  89   int           m_quality;
  90
  91         int                                             m_bitmapType ;
  92         PicHandle                       m_hPict ;
  93         WXHBITMAP     m_hBitmap;
  94         WXHICON m_hIcon ;
  95   wxMask *      m_bitmapMask; // Optional mask
  96 };
  97
  98 #define M_BITMAPDATA ((wxBitmapRefData *)m_refData)
  99
 100 class WXDLLEXPORT wxBitmapHandler: public wxBitmapHandlerBase
 101 {
 102   DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
 103 public:
 104   wxBitmapHandler() { m_name = ""; m_extension = ""; m_type = 0; };
 105 #ifdef __DARWIN__
 106   virtual ~wxBitmapHandler() { }
 107 #endif
 108
 109   virtual bool Create(wxBitmap *bitmap, void *data, long flags, int width, int height, int depth = 1);
 110   virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
 111       int desiredWidth, int desiredHeight);
 112   virtual bool SaveFile(const wxBitmap *bitmap, const wxString& name, int type, const wxPalette *palette = NULL);
 113
 114   inline void SetName(const wxString& name) { m_name = name; }
 115   inline void SetExtension(const wxString& ext) { m_extension = ext; }
 116   inline void SetType(long type) { m_type = type; }
 117   inline wxString GetName() const { return m_name; }
 118   inline wxString GetExtension() const { return m_extension; }
 119   inline long GetType() const { return m_type; }
 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   inline wxBitmap(const wxBitmap& bitmap)
 139   { Ref(bitmap); }
 140
 141   // Initialize with raw data.
 142   wxBitmap(const char bits[], int width, int height, int depth = 1);
 143
 144   // Initialize with XPM data
 145   bool CreateFromXpm(const char **bits);
 146   wxBitmap(const char **bits);
 147   wxBitmap(char **bits);
 148
 149   // Load a file or resource
 150   wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_PICT_RESOURCE);
 151
 152   // Constructor for generalised creation from data
 153   wxBitmap(void *data, wxBitmapType type, int width, int height, int depth = 1);
 154
 155   // If depth is omitted, will create a bitmap compatible with the display
 156   wxBitmap(int width, int height, int depth = -1);
 157
 158   // Convert from wxImage:
 159   wxBitmap(const wxImage& image, int depth = -1);
 160
 161   ~wxBitmap();
 162
 163   wxImage ConvertToImage() const;
 164
 165   // get the given part of bitmap
 166   wxBitmap GetSubBitmap( const wxRect& rect ) const;
 167
 168   virtual bool Create(int width, int height, int depth = -1);
 169   virtual bool Create(void *data, wxBitmapType type, int width, int height, int depth = 1);
 170   virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
 171   virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
 172
 173   // copies the contents and mask of the given (colour) icon to the bitmap
 174   virtual bool CopyFromIcon(const wxIcon& icon);
 175
 176   bool Ok() const;
 177   int GetWidth() const;
 178   int GetHeight() const;
 179   int GetDepth() const;
 180   int GetQuality() const;
 181   void SetWidth(int w);
 182   void SetHeight(int h);
 183   void SetDepth(int d);
 184   void SetQuality(int q);
 185   void SetOk(bool isOk);
 186
 187   wxPalette* GetPalette() const;
 188   void SetPalette(const wxPalette& palette);
 189
 190   wxMask *GetMask() const;
 191   void SetMask(wxMask *mask) ;
 192
 193   int GetBitmapType() const;
 194
 195   inline wxBitmap& operator = (const wxBitmap& bitmap) { if (*this == bitmap) return (*this); Ref(bitmap); return *this; }
 196   inline bool operator == (const wxBitmap& bitmap) { return m_refData == bitmap.m_refData; }
 197   inline bool operator != (const wxBitmap& bitmap) { return m_refData != bitmap.m_refData; }
 198
 199   // Format handling
 200   static inline wxList& GetHandlers() { return sm_handlers; }
 201   static void AddHandler(wxBitmapHandler *handler);
 202   static void InsertHandler(wxBitmapHandler *handler);
 203   static bool RemoveHandler(const wxString& name);
 204   static wxBitmapHandler *FindHandler(const wxString& name);
 205   static wxBitmapHandler *FindHandler(const wxString& extension, wxBitmapType type);
 206   static wxBitmapHandler *FindHandler(wxBitmapType type);
 207
 208   static void InitStandardHandlers();
 209   static void CleanUpHandlers();
 210 protected:
 211
 212   // TODO: Implementation
 213 public:
 214   void SetHBITMAP(WXHBITMAP bmp);
 215   WXHBITMAP GetHBITMAP() const;
 216   void SetHICON(WXHICON ico);
 217   inline WXHICON GetHICON() const { return (M_BITMAPDATA ? M_BITMAPDATA->m_hIcon : 0); }
 218
 219   PicHandle GetPict() const;
 220
 221   bool FreeResource(bool force = FALSE);
 222 };
 223 #endif
 224   // _WX_BITMAP_H_