include/wx/cocoa/bitmap.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/cocoa/bitmap.h
   3 // Purpose:     wxBitmap class
   4 // Author:      David Elliott
   5 // Modified by:
   6 // Created:     2003/07/19
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2003 David Elliott
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef __WX_COCOA_BITMAP_H__
  13 #define __WX_COCOA_BITMAP_H__
  14
  15 #include "wx/palette.h"
  16
  17 // Bitmap
  18 class WXDLLIMPEXP_FWD_CORE wxBitmap;
  19 class WXDLLIMPEXP_FWD_CORE wxIcon;
  20 class WXDLLIMPEXP_FWD_CORE wxCursor;
  21 class WXDLLIMPEXP_FWD_CORE wxImage;
  22 class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;
  23
  24 // ========================================================================
  25 // wxMask
  26 // ========================================================================
  27
  28 // A mask is a 1-bit alpha bitmap used for drawing bitmaps transparently.
  29 class WXDLLIMPEXP_CORE wxMask: public wxObject
  30 {
  31     DECLARE_DYNAMIC_CLASS(wxMask)
  32 public:
  33     wxMask();
  34
  35     // Construct a mask from a bitmap and a colour indicating
  36     // the transparent area
  37     wxMask(const wxBitmap& bitmap, const wxColour& colour);
  38
  39     // Construct a mask from a bitmap and a palette index indicating
  40     // the transparent area
  41     wxMask(const wxBitmap& bitmap, int paletteIndex);
  42
  43     // Construct a mask from a mono bitmap (copies the bitmap).
  44     wxMask(const wxBitmap& bitmap);
  45
  46     // Copy constructor
  47     wxMask(const wxMask& src);
  48
  49     virtual ~wxMask();
  50
  51     bool Create(const wxBitmap& bitmap, const wxColour& colour);
  52     bool Create(const wxBitmap& bitmap, int paletteIndex);
  53     bool Create(const wxBitmap& bitmap);
  54
  55     // wxCocoa
  56     inline WX_NSBitmapImageRep GetNSBitmapImageRep()
  57     {   return m_cocoaNSBitmapImageRep; }
  58 protected:
  59     WX_NSBitmapImageRep m_cocoaNSBitmapImageRep;
  60 };
  61
  62
  63 // ========================================================================
  64 // wxBitmap
  65 // ========================================================================
  66
  67 class WXDLLIMPEXP_CORE wxBitmap: public wxGDIObject,
  68                                  public wxBitmapHelpers
  69 {
  70 // ------------------------------------------------------------------------
  71 // initialization
  72 // ------------------------------------------------------------------------
  73 public:
  74     // Platform-specific default constructor
  75     wxBitmap();
  76     // Initialize with raw data.
  77     wxBitmap(const char bits[], int width, int height, int depth = 1);
  78     // Initialize with XPM data
  79     wxBitmap(const char* const* bits);
  80     // Load a file or resource
  81     wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
  82     // Construct from Cocoa's NSImage
  83     wxBitmap(NSImage* cocoaNSImage);
  84     // Construct from Cocoa's NSBitmapImageRep
  85     wxBitmap(NSBitmapImageRep* cocoaNSBitmapImageRep);
  86     // Constructor for generalised creation from data
  87     wxBitmap(const void* data, wxBitmapType type, int width, int height, int depth = 1);
  88     // If depth is omitted, will create a bitmap compatible with the display
  89     wxBitmap(int width, int height, int depth = -1)
  90         { (void)Create(width, height, depth); }
  91     wxBitmap(const wxSize& sz, int depth = -1)
  92         { (void)Create(sz, depth); }
  93     // Convert from wxImage:
  94     wxBitmap(const wxImage& image, int depth = -1)
  95         { CreateFromImage(image, depth); }
  96     // Convert from wxIcon
  97     wxBitmap(const wxIcon& icon) { CopyFromIcon(icon); }
  98
  99     // destructor
 100     virtual ~wxBitmap();
 101
 102 // ------------------------------------------------------------------------
 103 // Implementation
 104 // ------------------------------------------------------------------------
 105 public:
 106     // Initialize from wxImage
 107     bool CreateFromImage(const wxImage& image, int depth=-1);
 108
 109     virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
 110     virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH)
 111         { return Create(sz.GetWidth(), sz.GetHeight(), depth); }
 112
 113     bool Create(NSImage* cocoaNSImage);
 114     bool Create(NSBitmapImageRep* cocoaNSBitmapImageRep);
 115     virtual bool Create(const void* data, wxBitmapType type, int width, int height, int depth = 1);
 116     virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
 117     virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
 118
 119     // copies the contents and mask of the given (colour) icon to the bitmap
 120     virtual bool CopyFromIcon(const wxIcon& icon);
 121
 122     wxImage ConvertToImage() const;
 123
 124     // get the given part of bitmap
 125     wxBitmap GetSubBitmap( const wxRect& rect ) const;
 126
 127     int GetWidth() const;
 128     int GetHeight() const;
 129     int GetDepth() const;
 130     int GetQuality() const;
 131     void SetWidth(int w);
 132     void SetHeight(int h);
 133     void SetDepth(int d);
 134     void SetQuality(int q);
 135     void SetOk(bool isOk);
 136
 137     // raw bitmap access support functions
 138     void *GetRawData(wxPixelDataBase& data, int bpp);
 139     void UngetRawData(wxPixelDataBase& data);
 140
 141     wxPalette* GetPalette() const;
 142     void SetPalette(const wxPalette& palette);
 143
 144     wxMask *GetMask() const;
 145     void SetMask(wxMask *mask) ;
 146
 147     wxBitmapType GetBitmapType() const;
 148
 149     // wxCocoa
 150     WX_NSBitmapImageRep GetNSBitmapImageRep();
 151     void SetNSBitmapImageRep(WX_NSBitmapImageRep bitmapImageRep);
 152     WX_NSImage GetNSImage(bool useMask) const;
 153
 154     static void InitStandardHandlers() { }
 155     static void CleanUpHandlers() { }
 156
 157 protected:
 158     wxGDIRefData *CreateGDIRefData() const;
 159     wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
 160
 161     DECLARE_DYNAMIC_CLASS(wxBitmap)
 162 };
 163
 164
 165 #endif // __WX_COCOA_BITMAP_H__