]> git.saurik.com Git - wxWidgets.git/blob - include/wx/cocoa/bitmap.h
47dc498d965ea7d2aae0a2698e5b5b42d2c4cbf7
[wxWidgets.git] / include / wx / cocoa / bitmap.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: include/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 WXDLLEXPORT wxBitmap;
19 class WXDLLEXPORT wxIcon;
20 class WXDLLEXPORT wxCursor;
21 class WXDLLEXPORT wxImage;
22 class WXDLLEXPORT wxPixelDataBase;
23
24 // ========================================================================
25 // wxMask
26 // ========================================================================
27
28 // A mask is a 1-bit alpha bitmap used for drawing bitmaps transparently.
29 class WXDLLEXPORT 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 ~wxMask();
47
48 bool Create(const wxBitmap& bitmap, const wxColour& colour);
49 bool Create(const wxBitmap& bitmap, int paletteIndex);
50 bool Create(const wxBitmap& bitmap);
51
52 // wxCocoa
53 inline WX_NSBitmapImageRep GetNSBitmapImageRep()
54 { return m_cocoaNSBitmapImageRep; }
55 protected:
56 WX_NSBitmapImageRep m_cocoaNSBitmapImageRep;
57 };
58
59 // ========================================================================
60 // wxBitmap
61 // ========================================================================
62 class WXDLLEXPORT wxBitmap: public wxGDIObject
63 {
64 DECLARE_DYNAMIC_CLASS(wxBitmap)
65 // ------------------------------------------------------------------------
66 // initialization
67 // ------------------------------------------------------------------------
68 public:
69 // Platform-specific default constructor
70 wxBitmap();
71 // Copy constructors
72 wxBitmap(const wxBitmap& bitmap)
73 : wxGDIObject()
74 { Ref(bitmap); }
75 // Initialize with raw data.
76 wxBitmap(const char bits[], int width, int height, int depth = 1);
77 // Initialize with XPM data
78 wxBitmap(const char **bits) { CreateFromXpm(bits); }
79 wxBitmap(char **bits) { CreateFromXpm((const char**)bits); }
80 // Load a file or resource
81 wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
82 // Constructor for generalised creation from data
83 wxBitmap(void *data, wxBitmapType type, int width, int height, int depth = 1);
84 // If depth is omitted, will create a bitmap compatible with the display
85 wxBitmap(int width, int height, int depth = -1);
86 // Convert from wxImage:
87 wxBitmap(const wxImage& image, int depth = -1)
88 { CreateFromImage(image, depth); }
89 // Convert from wxIcon
90 wxBitmap(const wxIcon& icon) { CopyFromIcon(icon); }
91
92 // destructor
93 ~wxBitmap();
94
95 // ------------------------------------------------------------------------
96 // Implementation
97 // ------------------------------------------------------------------------
98 public:
99 // Initialize with XPM data
100 bool CreateFromXpm(const char **bits);
101 // Initialize from wxImage
102 bool CreateFromImage(const wxImage& image, int depth=-1);
103
104 virtual bool Create(int width, int height, int depth = -1);
105 virtual bool Create(void *data, wxBitmapType type, int width, int height, int depth = 1);
106 virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
107 virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
108
109 // copies the contents and mask of the given (colour) icon to the bitmap
110 virtual bool CopyFromIcon(const wxIcon& icon);
111
112 wxImage ConvertToImage() const;
113
114 // get the given part of bitmap
115 wxBitmap GetSubBitmap( const wxRect& rect ) const;
116
117 bool Ok() const;
118 int GetWidth() const;
119 int GetHeight() const;
120 int GetDepth() const;
121 int GetQuality() const;
122 void SetWidth(int w);
123 void SetHeight(int h);
124 void SetDepth(int d);
125 void SetQuality(int q);
126 void SetOk(bool isOk);
127
128 // raw bitmap access support functions
129 void *GetRawData(wxPixelDataBase& data, int bpp);
130 void UngetRawData(wxPixelDataBase& data);
131
132 wxPalette* GetPalette() const;
133 void SetPalette(const wxPalette& palette);
134
135 wxMask *GetMask() const;
136 void SetMask(wxMask *mask) ;
137
138 int GetBitmapType() const;
139
140 inline wxBitmap& operator = (const wxBitmap& bitmap)
141 { if (*this == bitmap) return (*this); Ref(bitmap); return *this; }
142 inline bool operator == (const wxBitmap& bitmap) const
143 { return m_refData == bitmap.m_refData; }
144 inline bool operator != (const wxBitmap& bitmap) const
145 { return m_refData != bitmap.m_refData; }
146
147 // wxObjectRefData
148 wxObjectRefData *CreateRefData() const;
149 wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
150
151 // wxCocoa
152 WX_NSBitmapImageRep GetNSBitmapImageRep();
153 void SetNSBitmapImageRep(WX_NSBitmapImageRep bitmapImageRep);
154 WX_NSImage GetNSImage(bool useMask) const;
155
156 static void InitStandardHandlers() { }
157 static void CleanUpHandlers() { }
158 };
159
160 #endif // __WX_COCOA_BITMAP_H__