| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: wx/palmos/bitmap.h |
| 3 | // Purpose: wxBitmap class |
| 4 | // Author: William Osborne - minimal working wxPalmOS port |
| 5 | // Modified by: |
| 6 | // Created: 10/13/04 |
| 7 | // RCS-ID: $Id$ |
| 8 | // Copyright: (c) William Osborne |
| 9 | // Licence: wxWindows licence |
| 10 | ///////////////////////////////////////////////////////////////////////////// |
| 11 | |
| 12 | #ifndef _WX_BITMAP_H_ |
| 13 | #define _WX_BITMAP_H_ |
| 14 | |
| 15 | #include "wx/palmos/gdiimage.h" |
| 16 | #include "wx/gdicmn.h" |
| 17 | #include "wx/palette.h" |
| 18 | |
| 19 | class WXDLLIMPEXP_FWD_CORE wxBitmap; |
| 20 | class WXDLLIMPEXP_FWD_CORE wxBitmapHandler; |
| 21 | class WXDLLIMPEXP_FWD_CORE wxBitmapRefData; |
| 22 | class WXDLLIMPEXP_FWD_CORE wxControl; |
| 23 | class WXDLLIMPEXP_FWD_CORE wxCursor; |
| 24 | class WXDLLIMPEXP_FWD_CORE wxDC; |
| 25 | #if wxUSE_WXDIB |
| 26 | class WXDLLIMPEXP_FWD_CORE wxDIB; |
| 27 | #endif |
| 28 | class WXDLLIMPEXP_FWD_CORE wxIcon; |
| 29 | class WXDLLIMPEXP_FWD_CORE wxImage; |
| 30 | class WXDLLIMPEXP_FWD_CORE wxMask; |
| 31 | class WXDLLIMPEXP_FWD_CORE wxPalette; |
| 32 | class WXDLLIMPEXP_FWD_CORE wxPixelDataBase; |
| 33 | |
| 34 | // ---------------------------------------------------------------------------- |
| 35 | // wxBitmap: a mono or colour bitmap |
| 36 | // ---------------------------------------------------------------------------- |
| 37 | |
| 38 | class WXDLLIMPEXP_CORE wxBitmap : public wxGDIImage |
| 39 | { |
| 40 | public: |
| 41 | // default ctor creates an invalid bitmap, you must Create() it later |
| 42 | wxBitmap() { Init(); } |
| 43 | |
| 44 | // Initialize with raw data |
| 45 | wxBitmap(const char bits[], int width, int height, int depth = 1); |
| 46 | |
| 47 | // Initialize with XPM data |
| 48 | wxBitmap(const char* const* data); |
| 49 | |
| 50 | // Load a file or resource |
| 51 | wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE); |
| 52 | |
| 53 | // New constructor for generalised creation from data |
| 54 | wxBitmap(const void* data, long type, int width, int height, int depth = 1); |
| 55 | |
| 56 | // Create a new, uninitialized bitmap of the given size and depth (if it |
| 57 | // is omitted, will create a bitmap compatible with the display) |
| 58 | // |
| 59 | // NB: this ctor will create a DIB for 24 and 32bpp bitmaps, use ctor |
| 60 | // taking a DC argument if you want to force using DDB in this case |
| 61 | wxBitmap(int width, int height, int depth = -1); |
| 62 | |
| 63 | // Create a bitmap compatible with the given DC |
| 64 | wxBitmap(int width, int height, const wxDC& dc); |
| 65 | |
| 66 | #if wxUSE_IMAGE && wxUSE_WXDIB |
| 67 | // Convert from wxImage |
| 68 | wxBitmap(const wxImage& image, int depth = -1) |
| 69 | { (void)CreateFromImage(image, depth); } |
| 70 | |
| 71 | // Create a DDB compatible with the given DC from wxImage |
| 72 | wxBitmap(const wxImage& image, const wxDC& dc) |
| 73 | { (void)CreateFromImage(image, dc); } |
| 74 | #endif // wxUSE_IMAGE |
| 75 | |
| 76 | // we must have this, otherwise icons are silently copied into bitmaps using |
| 77 | // the copy ctor but the resulting bitmap is invalid! |
| 78 | wxBitmap(const wxIcon& icon) { Init(); CopyFromIcon(icon); } |
| 79 | |
| 80 | wxBitmap& operator=(const wxIcon& icon) |
| 81 | { |
| 82 | (void)CopyFromIcon(icon); |
| 83 | |
| 84 | return *this; |
| 85 | } |
| 86 | |
| 87 | wxBitmap& operator=(const wxCursor& cursor) |
| 88 | { |
| 89 | (void)CopyFromCursor(cursor); |
| 90 | |
| 91 | return *this; |
| 92 | } |
| 93 | |
| 94 | virtual ~wxBitmap(); |
| 95 | |
| 96 | #if wxUSE_IMAGE && wxUSE_WXDIB |
| 97 | wxImage ConvertToImage() const; |
| 98 | #endif // wxUSE_IMAGE |
| 99 | |
| 100 | // get the given part of bitmap |
| 101 | wxBitmap GetSubBitmap( const wxRect& rect ) const; |
| 102 | |
| 103 | // copies the contents and mask of the given (colour) icon to the bitmap |
| 104 | bool CopyFromIcon(const wxIcon& icon); |
| 105 | |
| 106 | // copies the contents and mask of the given cursor to the bitmap |
| 107 | bool CopyFromCursor(const wxCursor& cursor); |
| 108 | |
| 109 | #if wxUSE_WXDIB |
| 110 | // copies from a device independent bitmap |
| 111 | bool CopyFromDIB(const wxDIB& dib); |
| 112 | #endif |
| 113 | |
| 114 | virtual bool Create(int width, int height, int depth = -1); |
| 115 | virtual bool Create(int width, int height, const wxDC& dc); |
| 116 | virtual bool Create(const void* data, long type, int width, int height, int depth = 1); |
| 117 | virtual bool LoadFile(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE); |
| 118 | virtual bool SaveFile(const wxString& name, int type, const wxPalette *cmap = NULL); |
| 119 | |
| 120 | wxBitmapRefData *GetBitmapData() const |
| 121 | { return (wxBitmapRefData *)m_refData; } |
| 122 | |
| 123 | // raw bitmap access support functions |
| 124 | void *GetRawData(wxPixelDataBase& data, int bpp); |
| 125 | void UngetRawData(wxPixelDataBase& data); |
| 126 | |
| 127 | #if wxUSE_PALETTE |
| 128 | wxPalette* GetPalette() const; |
| 129 | void SetPalette(const wxPalette& palette); |
| 130 | #endif // wxUSE_PALETTE |
| 131 | |
| 132 | wxMask *GetMask() const; |
| 133 | void SetMask(wxMask *mask); |
| 134 | |
| 135 | // these functions are internal and shouldn't be used, they risk to |
| 136 | // disappear in the future |
| 137 | bool HasAlpha() const; |
| 138 | |
| 139 | // implementation only from now on |
| 140 | // ------------------------------- |
| 141 | |
| 142 | public: |
| 143 | void SetHBITMAP(WXHBITMAP bmp) { SetHandle((WXHANDLE)bmp); } |
| 144 | WXHBITMAP GetHBITMAP() const { return (WXHBITMAP)GetHandle(); } |
| 145 | |
| 146 | #ifdef __WXDEBUG__ |
| 147 | void SetSelectedInto(wxDC *dc); |
| 148 | wxDC *GetSelectedInto() const; |
| 149 | #endif // __WXDEBUG__ |
| 150 | |
| 151 | protected: |
| 152 | // common part of all ctors |
| 153 | void Init(); |
| 154 | |
| 155 | virtual wxGDIImageRefData *CreateData() const; |
| 156 | |
| 157 | // creates an uninitialized bitmap, called from Create()s above |
| 158 | bool DoCreate(int w, int h, int depth, WXHDC hdc); |
| 159 | |
| 160 | #if wxUSE_IMAGE && wxUSE_WXDIB |
| 161 | // creates the bitmap from wxImage, supposed to be called from ctor |
| 162 | bool CreateFromImage(const wxImage& image, int depth); |
| 163 | |
| 164 | // creates a DDB from wxImage, supposed to be called from ctor |
| 165 | bool CreateFromImage(const wxImage& image, const wxDC& dc); |
| 166 | |
| 167 | // common part of the 2 methods above (hdc may be 0) |
| 168 | bool CreateFromImage(const wxImage& image, int depth, WXHDC hdc); |
| 169 | #endif // wxUSE_IMAGE |
| 170 | |
| 171 | private: |
| 172 | DECLARE_DYNAMIC_CLASS(wxBitmap) |
| 173 | }; |
| 174 | |
| 175 | // ---------------------------------------------------------------------------- |
| 176 | // wxMask: a mono bitmap used for drawing bitmaps transparently. |
| 177 | // ---------------------------------------------------------------------------- |
| 178 | |
| 179 | class WXDLLIMPEXP_CORE wxMask : public wxObject |
| 180 | { |
| 181 | public: |
| 182 | wxMask(); |
| 183 | |
| 184 | // Construct a mask from a bitmap and a colour indicating the transparent |
| 185 | // area |
| 186 | wxMask(const wxBitmap& bitmap, const wxColour& colour); |
| 187 | |
| 188 | // Construct a mask from a bitmap and a palette index indicating the |
| 189 | // transparent area |
| 190 | wxMask(const wxBitmap& bitmap, int paletteIndex); |
| 191 | |
| 192 | // Construct a mask from a mono bitmap (copies the bitmap). |
| 193 | wxMask(const wxBitmap& bitmap); |
| 194 | |
| 195 | // construct a mask from the givne bitmap handle |
| 196 | wxMask(WXHBITMAP hbmp) { m_maskBitmap = hbmp; } |
| 197 | |
| 198 | virtual ~wxMask(); |
| 199 | |
| 200 | bool Create(const wxBitmap& bitmap, const wxColour& colour); |
| 201 | bool Create(const wxBitmap& bitmap, int paletteIndex); |
| 202 | bool Create(const wxBitmap& bitmap); |
| 203 | |
| 204 | // Implementation |
| 205 | WXHBITMAP GetMaskBitmap() const { return m_maskBitmap; } |
| 206 | void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; } |
| 207 | |
| 208 | protected: |
| 209 | WXHBITMAP m_maskBitmap; |
| 210 | |
| 211 | DECLARE_DYNAMIC_CLASS(wxMask) |
| 212 | }; |
| 213 | |
| 214 | // ---------------------------------------------------------------------------- |
| 215 | // wxBitmapHandler is a class which knows how to load/save bitmaps to/from file |
| 216 | // ---------------------------------------------------------------------------- |
| 217 | |
| 218 | class WXDLLIMPEXP_CORE wxBitmapHandler : public wxGDIImageHandler |
| 219 | { |
| 220 | public: |
| 221 | wxBitmapHandler() { m_type = wxBITMAP_TYPE_INVALID; } |
| 222 | wxBitmapHandler(const wxString& name, const wxString& ext, long type) |
| 223 | : wxGDIImageHandler(name, ext, type) |
| 224 | { |
| 225 | } |
| 226 | |
| 227 | // keep wxBitmapHandler derived from wxGDIImageHandler compatible with the |
| 228 | // old class which worked only with bitmaps |
| 229 | virtual bool Create(wxBitmap *bitmap, |
| 230 | const void* data, |
| 231 | long flags, |
| 232 | int width, int height, int depth = 1); |
| 233 | virtual bool LoadFile(wxBitmap *bitmap, |
| 234 | const wxString& name, |
| 235 | long flags, |
| 236 | int desiredWidth, int desiredHeight); |
| 237 | virtual bool SaveFile(wxBitmap *bitmap, |
| 238 | const wxString& name, |
| 239 | int type, |
| 240 | const wxPalette *palette = NULL); |
| 241 | |
| 242 | virtual bool Create(wxGDIImage *image, |
| 243 | const void* data, |
| 244 | long flags, |
| 245 | int width, int height, int depth = 1); |
| 246 | virtual bool Load(wxGDIImage *image, |
| 247 | const wxString& name, |
| 248 | long flags, |
| 249 | int desiredWidth, int desiredHeight); |
| 250 | virtual bool Save(wxGDIImage *image, |
| 251 | const wxString& name, |
| 252 | int type); |
| 253 | |
| 254 | private: |
| 255 | DECLARE_DYNAMIC_CLASS(wxBitmapHandler) |
| 256 | }; |
| 257 | |
| 258 | #endif |
| 259 | // _WX_BITMAP_H_ |