1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxBitmap class interface
4 // Author: Vaclav Slavik
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_BITMAP_H_BASE_
13 #define _WX_BITMAP_H_BASE_
15 // ----------------------------------------------------------------------------
17 // ----------------------------------------------------------------------------
20 #include "wx/object.h"
21 #include "wx/string.h"
22 #include "wx/gdiobj.h"
23 #include "wx/gdicmn.h" // for wxBitmapType
25 class WXDLLEXPORT wxBitmap
;
26 class WXDLLEXPORT wxBitmapHandler
;
27 class WXDLLEXPORT wxImage
;
28 class WXDLLEXPORT wxMask
;
29 class WXDLLEXPORT wxPalette
;
31 #if defined(__WXMGL__) || \
32 defined(__WXDFB__) || \
33 defined(__WXMAC__) || \
34 defined(__WXGTK__) || \
35 defined(__WXCOCOA__) || \
36 defined(__WXMOTIF__) || \
38 #define wxUSE_BITMAP_BASE 1
40 #define wxUSE_BITMAP_BASE 0
43 // Only used by some ports
44 // FIXME -- make all ports (but MSW which uses wxGDIImage) use these base classes
47 // ----------------------------------------------------------------------------
48 // wxBitmapHandler: class which knows how to create/load/save bitmaps in
50 // ----------------------------------------------------------------------------
52 class WXDLLEXPORT wxBitmapHandlerBase
: public wxObject
58 , m_type(wxBITMAP_TYPE_INVALID
)
61 virtual ~wxBitmapHandlerBase() { }
63 virtual bool Create(wxBitmap
*bitmap
, void *data
, long flags
,
64 int width
, int height
, int depth
= 1) = 0;
65 virtual bool LoadFile(wxBitmap
*bitmap
, const wxString
& name
, long flags
,
66 int desiredWidth
, int desiredHeight
) = 0;
67 virtual bool SaveFile(const wxBitmap
*bitmap
, const wxString
& name
,
68 int type
, const wxPalette
*palette
= NULL
) = 0;
70 void SetName(const wxString
& name
) { m_name
= name
; }
71 void SetExtension(const wxString
& ext
) { m_extension
= ext
; }
72 void SetType(wxBitmapType type
) { m_type
= type
; }
73 wxString
GetName() const { return m_name
; }
74 wxString
GetExtension() const { return m_extension
; }
75 wxBitmapType
GetType() const { return m_type
; }
83 DECLARE_ABSTRACT_CLASS(wxBitmapHandlerBase
)
86 class WXDLLEXPORT wxBitmapBase
: public wxGDIObject
90 Derived class must implement these:
93 wxBitmap(int width, int height, int depth = -1);
94 wxBitmap(const char bits[], int width, int height, int depth = 1);
95 wxBitmap(const char **bits);
96 wxBitmap(char **bits);
97 wxBitmap(const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM);
98 wxBitmap(const wxImage& image, int depth = -1);
99 bool operator == (const wxBitmap& bmp) const;
100 bool operator != (const wxBitmap& bmp) const;
102 bool Create(int width, int height, int depth = -1);
104 static void InitStandardHandlers();
107 virtual bool Ok() const = 0;
109 virtual int GetHeight() const = 0;
110 virtual int GetWidth() const = 0;
111 virtual int GetDepth() const = 0;
113 virtual wxImage
ConvertToImage() const = 0;
115 virtual wxMask
*GetMask() const = 0;
116 virtual void SetMask(wxMask
*mask
) = 0;
118 virtual wxBitmap
GetSubBitmap(const wxRect
& rect
) const = 0;
120 virtual bool SaveFile(const wxString
&name
, wxBitmapType type
,
121 const wxPalette
*palette
= (wxPalette
*)NULL
) const = 0;
122 virtual bool LoadFile(const wxString
&name
, wxBitmapType type
) = 0;
125 If raw bitmap access is supported (see wx/rawbmp.h), the following
126 methods should be implemented:
128 virtual bool GetRawData(wxRawBitmapData *data) = 0;
129 virtual void UngetRawData(wxRawBitmapData *data) = 0;
133 virtual wxPalette
*GetPalette() const = 0;
134 virtual void SetPalette(const wxPalette
& palette
) = 0;
135 #endif // wxUSE_PALETTE
137 // copies the contents and mask of the given (colour) icon to the bitmap
138 virtual bool CopyFromIcon(const wxIcon
& icon
) = 0;
141 virtual void SetHeight(int height
) = 0;
142 virtual void SetWidth(int width
) = 0;
143 virtual void SetDepth(int depth
) = 0;
146 static inline wxList
& GetHandlers() { return sm_handlers
; }
147 static void AddHandler(wxBitmapHandlerBase
*handler
);
148 static void InsertHandler(wxBitmapHandlerBase
*handler
);
149 static bool RemoveHandler(const wxString
& name
);
150 static wxBitmapHandler
*FindHandler(const wxString
& name
);
151 static wxBitmapHandler
*FindHandler(const wxString
& extension
, wxBitmapType bitmapType
);
152 static wxBitmapHandler
*FindHandler(wxBitmapType bitmapType
);
154 //static void InitStandardHandlers();
155 // (wxBitmap must implement this one)
157 static void CleanUpHandlers();
160 static wxList sm_handlers
;
162 DECLARE_ABSTRACT_CLASS(wxBitmapBase
)
165 #endif // wxUSE_BITMAP_BASE
167 #if defined(__WXPALMOS__)
168 #include "wx/palmos/bitmap.h"
169 #elif defined(__WXMSW__)
170 #include "wx/msw/bitmap.h"
171 #elif defined(__WXMOTIF__)
172 #include "wx/x11/bitmap.h"
173 #elif defined(__WXGTK20__)
174 #include "wx/gtk/bitmap.h"
175 #elif defined(__WXGTK__)
176 #include "wx/gtk1/bitmap.h"
177 #elif defined(__WXX11__)
178 #include "wx/x11/bitmap.h"
179 #elif defined(__WXMGL__)
180 #include "wx/mgl/bitmap.h"
181 #elif defined(__WXDFB__)
182 #include "wx/dfb/bitmap.h"
183 #elif defined(__WXMAC__)
184 #include "wx/mac/bitmap.h"
185 #elif defined(__WXCOCOA__)
186 #include "wx/cocoa/bitmap.h"
187 #elif defined(__WXPM__)
188 #include "wx/os2/bitmap.h"
191 #endif // _WX_BITMAP_H_BASE_