]> git.saurik.com Git - wxWidgets.git/blob - include/wx/cocoa/bitmap.h
build fixes
[wxWidgets.git] / 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 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 // 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 // wxBitmap
64 // ========================================================================
65 class WXDLLEXPORT wxBitmap: public wxGDIObject
66 {
67 DECLARE_DYNAMIC_CLASS(wxBitmap)
68 // ------------------------------------------------------------------------
69 // initialization
70 // ------------------------------------------------------------------------
71 public:
72 // Platform-specific default constructor
73 wxBitmap();
74 // Initialize with raw data.
75 wxBitmap(const char bits[], int width, int height, int depth = 1);
76 // Initialize with XPM data
77 wxBitmap(const char* const* bits);
78 // Load a file or resource
79 wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
80 // Construct from Cocoa's NSImage
81 wxBitmap(NSImage* cocoaNSImage);
82 // Construct from Cocoa's NSBitmapImageRep
83 wxBitmap(NSBitmapImageRep* cocoaNSBitmapImageRep);
84 // Constructor for generalised creation from data
85 wxBitmap(const void* data, wxBitmapType type, int width, int height, int depth = 1);
86 // If depth is omitted, will create a bitmap compatible with the display
87 wxBitmap(int width, int height, int depth = -1);
88 // Convert from wxImage:
89 wxBitmap(const wxImage& image, int depth = -1)
90 { CreateFromImage(image, depth); }
91 // Convert from wxIcon
92 wxBitmap(const wxIcon& icon) { CopyFromIcon(icon); }
93
94 // destructor
95 virtual ~wxBitmap();
96
97 // ------------------------------------------------------------------------
98 // Implementation
99 // ------------------------------------------------------------------------
100 public:
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 bool Create(NSImage* cocoaNSImage);
106 bool Create(NSBitmapImageRep* cocoaNSBitmapImageRep);
107 virtual bool Create(const void* data, wxBitmapType type, int width, int height, int depth = 1);
108 virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
109 virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
110
111 // copies the contents and mask of the given (colour) icon to the bitmap
112 virtual bool CopyFromIcon(const wxIcon& icon);
113
114 wxImage ConvertToImage() const;
115
116 // get the given part of bitmap
117 wxBitmap GetSubBitmap( const wxRect& rect ) const;
118
119 bool Ok() const { return IsOk(); }
120 bool IsOk() const;
121 int GetWidth() const;
122 int GetHeight() const;
123 int GetDepth() const;
124 int GetQuality() const;
125 void SetWidth(int w);
126 void SetHeight(int h);
127 void SetDepth(int d);
128 void SetQuality(int q);
129 void SetOk(bool isOk);
130
131 // raw bitmap access support functions
132 void *GetRawData(wxPixelDataBase& data, int bpp);
133 void UngetRawData(wxPixelDataBase& data);
134
135 wxPalette* GetPalette() const;
136 void SetPalette(const wxPalette& palette);
137
138 wxMask *GetMask() const;
139 void SetMask(wxMask *mask) ;
140
141 int GetBitmapType() const;
142
143 // wxObjectRefData
144 wxObjectRefData *CreateRefData() const;
145 wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
146
147 // wxCocoa
148 WX_NSBitmapImageRep GetNSBitmapImageRep();
149 void SetNSBitmapImageRep(WX_NSBitmapImageRep bitmapImageRep);
150 WX_NSImage GetNSImage(bool useMask) const;
151
152 static void InitStandardHandlers() { }
153 static void CleanUpHandlers() { }
154 };
155
156 class WXDLLIMPEXP_CORE wxBitmapHandler: public wxBitmapHandlerBase
157 {
158 DECLARE_ABSTRACT_CLASS(wxBitmapHandler)
159 };
160
161 #endif
162 // __WX_COCOA_BITMAP_H__