]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: bitmap.h | |
3 | // Purpose: wxBitmap class | |
4 | // Author: Julian Smart | |
5 | // Modified by: | |
6 | // Created: 01/02/97 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) Julian Smart | |
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 | ||
31 | // A mask is a mono bitmap used for drawing bitmaps | |
32 | // transparently. | |
33 | class WXDLLEXPORT wxMask: public wxObject | |
34 | { | |
35 | DECLARE_DYNAMIC_CLASS(wxMask) | |
36 | ||
37 | public: | |
38 | wxMask(void); | |
39 | ||
40 | // Construct a mask from a bitmap and a colour indicating | |
41 | // the transparent area | |
42 | wxMask(const wxBitmap& bitmap, const wxColour& colour); | |
43 | ||
44 | // Construct a mask from a bitmap and a palette index indicating | |
45 | // the transparent area | |
46 | wxMask(const wxBitmap& bitmap, int paletteIndex); | |
47 | ||
48 | // Construct a mask from a mono bitmap (copies the bitmap). | |
49 | wxMask(const wxBitmap& bitmap); | |
50 | ||
51 | ~wxMask(void); | |
52 | ||
53 | bool Create(const wxBitmap& bitmap, const wxColour& colour); | |
54 | bool Create(const wxBitmap& bitmap, int paletteIndex); | |
55 | bool Create(const wxBitmap& bitmap); | |
56 | ||
57 | // Implementation | |
58 | inline WXHBITMAP GetMaskBitmap(void) const { return m_maskBitmap; } | |
59 | inline void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; } | |
60 | protected: | |
61 | WXHBITMAP m_maskBitmap; | |
62 | }; | |
63 | ||
64 | class WXDLLEXPORT wxBitmapRefData: public wxGDIRefData | |
65 | { | |
66 | friend class WXDLLEXPORT wxBitmap; | |
67 | friend class WXDLLEXPORT wxIcon; | |
68 | friend class WXDLLEXPORT wxCursor; | |
69 | public: | |
70 | wxBitmapRefData(void); | |
71 | ~wxBitmapRefData(void); | |
72 | ||
73 | public: | |
74 | int m_width; | |
75 | int m_height; | |
76 | int m_depth; | |
77 | bool m_ok; | |
78 | int m_numColors; | |
79 | wxPalette m_bitmapPalette; | |
80 | int m_quality; | |
81 | ||
82 | #ifdef __WXMSW__ | |
83 | WXHBITMAP m_hBitmap; | |
84 | wxDC * m_selectedInto; // So bitmap knows whether it's been selected into | |
85 | // a device context (for error checking) | |
86 | wxMask * m_bitmapMask; // Option mask | |
87 | #endif | |
88 | }; | |
89 | ||
90 | #define M_BITMAPDATA ((wxBitmapRefData *)m_refData) | |
91 | ||
92 | class WXDLLEXPORT wxBitmapHandler: public wxObject | |
93 | { | |
94 | DECLARE_DYNAMIC_CLASS(wxBitmapHandler) | |
95 | public: | |
96 | wxBitmapHandler(void) { m_name = ""; m_extension = ""; m_type = 0; }; | |
97 | ||
98 | virtual bool Create(wxBitmap *bitmap, void *data, long flags, int width, int height, int depth = 1); | |
99 | virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags, | |
100 | int desiredWidth, int desiredHeight); | |
101 | virtual bool SaveFile(wxBitmap *bitmap, const wxString& name, int type, const wxPalette *palette = NULL); | |
102 | ||
103 | inline void SetName(const wxString& name) { m_name = name; } | |
104 | inline void SetExtension(const wxString& ext) { m_extension = ext; } | |
105 | inline void SetType(long type) { m_type = type; } | |
106 | inline wxString GetName(void) const { return m_name; } | |
107 | inline wxString GetExtension(void) const { return m_extension; } | |
108 | inline long GetType(void) const { return m_type; } | |
109 | protected: | |
110 | wxString m_name; | |
111 | wxString m_extension; | |
112 | long m_type; | |
113 | }; | |
114 | #define M_BITMAPHANDLERDATA ((wxBitmapRefData *)bitmap->GetRefData()) | |
115 | ||
116 | class WXDLLEXPORT wxBitmap: public wxGDIObject | |
117 | { | |
118 | DECLARE_DYNAMIC_CLASS(wxBitmap) | |
119 | ||
120 | friend class WXDLLEXPORT wxBitmapHandler; | |
121 | ||
122 | public: | |
123 | wxBitmap(void); // Platform-specific | |
124 | ||
125 | // Copy constructors | |
126 | inline wxBitmap(const wxBitmap& bitmap) | |
127 | { Ref(bitmap); if ( wxTheBitmapList ) wxTheBitmapList->AddBitmap(this); } | |
128 | inline wxBitmap(const wxBitmap* bitmap) { if (bitmap) Ref(*bitmap); if ( wxTheBitmapList ) wxTheBitmapList->AddBitmap(this); } | |
129 | ||
130 | // Initialize with raw data | |
131 | wxBitmap(const char bits[], int width, int height, int depth = 1); | |
132 | ||
133 | #if wxUSE_XPM_IN_MSW | |
134 | class wxItem; | |
135 | // Initialize with XPM data | |
136 | wxBitmap(const char **data, wxItem *anItem = NULL); | |
137 | #endif | |
138 | ||
139 | // Load a file or resource | |
140 | wxBitmap(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE); | |
141 | ||
142 | // New constructor for generalised creation from data | |
143 | wxBitmap(void *data, long type, int width, int height, int depth = 1); | |
144 | ||
145 | // If depth is omitted, will create a bitmap compatible with the display | |
146 | wxBitmap(int width, int height, int depth = -1); | |
147 | ~wxBitmap(void); | |
148 | ||
149 | virtual bool Create(int width, int height, int depth = -1); | |
150 | virtual bool Create(void *data, long type, int width, int height, int depth = 1); | |
151 | virtual bool LoadFile(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE); | |
152 | virtual bool SaveFile(const wxString& name, int type, const wxPalette *cmap = NULL); | |
153 | ||
154 | inline bool Ok(void) const { return (M_BITMAPDATA && M_BITMAPDATA->m_ok); } | |
155 | inline int GetWidth(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_width : 0); } | |
156 | inline int GetHeight(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_height : 0); } | |
157 | inline int GetDepth(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_depth : 0); } | |
158 | inline int GetQuality(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_quality : 0); } | |
159 | void SetWidth(int w); | |
160 | void SetHeight(int h); | |
161 | void SetDepth(int d); | |
162 | void SetQuality(int q); | |
163 | void SetOk(bool isOk); | |
164 | #if WXWIN_COMPATIBILITY | |
165 | inline wxPalette *GetColourMap(void) const { return GetPalette(); } | |
166 | void SetColourMap(wxPalette *cmap) { SetPalette(*cmap); }; | |
167 | #endif | |
168 | inline wxPalette* GetPalette(void) const { return (M_BITMAPDATA ? (& M_BITMAPDATA->m_bitmapPalette) : NULL); } | |
169 | void SetPalette(const wxPalette& palette); | |
170 | ||
171 | inline wxMask *GetMask(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_bitmapMask : NULL); } | |
172 | void SetMask(wxMask *mask) ; | |
173 | ||
174 | inline wxBitmap& operator = (const wxBitmap& bitmap) { if (*this == bitmap) return (*this); Ref(bitmap); return *this; } | |
175 | inline bool operator == (const wxBitmap& bitmap) { return m_refData == bitmap.m_refData; } | |
176 | inline bool operator != (const wxBitmap& bitmap) { return m_refData != bitmap.m_refData; } | |
177 | ||
178 | // Format handling | |
179 | static inline wxList& GetHandlers(void) { return sm_handlers; } | |
180 | static void AddHandler(wxBitmapHandler *handler); | |
181 | static void InsertHandler(wxBitmapHandler *handler); | |
182 | static bool RemoveHandler(const wxString& name); | |
183 | static wxBitmapHandler *FindHandler(const wxString& name); | |
184 | static wxBitmapHandler *FindHandler(const wxString& extension, long bitmapType); | |
185 | static wxBitmapHandler *FindHandler(long bitmapType); | |
186 | ||
187 | static void InitStandardHandlers(void); | |
188 | static void CleanUpHandlers(void); | |
189 | protected: | |
190 | static wxList sm_handlers; | |
191 | ||
192 | // Implementation | |
193 | public: | |
194 | void SetHBITMAP(WXHBITMAP bmp); | |
195 | inline WXHBITMAP GetHBITMAP(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_hBitmap : 0); } | |
196 | inline void SetSelectedInto(wxDC *dc) { if (M_BITMAPDATA) M_BITMAPDATA->m_selectedInto = dc; } | |
197 | inline wxDC *GetSelectedInto(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_selectedInto : NULL); } | |
198 | bool FreeResource(bool force = FALSE); | |
199 | ||
200 | // Creates a bitmap that matches the device context's depth, from | |
201 | // an arbitray bitmap. At present, the original bitmap must have an | |
202 | // associated palette. (TODO: use a default palette if no palette exists.) | |
203 | // This function is necessary for you to Blit an arbitrary bitmap (which may have | |
204 | // the wrong depth). wxDC::SelectObject will compare the depth of the bitmap | |
205 | // with the DC's depth, and create a new bitmap if the depths differ. | |
206 | // Eventually we should perhaps make this a public API function so that | |
207 | // an app can efficiently produce bitmaps of the correct depth. | |
208 | // The Windows solution is to use SetDibBits to blit an arbotrary DIB directly to a DC, but | |
209 | // this is too Windows-specific, hence this solution of quietly converting the wxBitmap. | |
210 | // Contributed by Frederic Villeneuve <frederic.villeneuve@natinst.com> | |
211 | wxBitmap GetBitmapForDC(wxDC& dc) const; | |
212 | ||
213 | }; | |
214 | #endif | |
215 | // _WX_BITMAP_H_ |