/////////////////////////////////////////////////////////////////////////////
-// Name: bitmap.h
+// Name: wx/msw/bitmap.h
// Purpose: wxBitmap class
// Author: Julian Smart
// Modified by:
// Created: 01/02/97
// RCS-ID: $Id$
// Copyright: (c) Julian Smart
-// Licence: wxWindows licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_BITMAP_H_
#define _WX_BITMAP_H_
-#ifdef __GNUG__
-#pragma interface "bitmap.h"
-#endif
-
-#include "wx/gdiobj.h"
-#include "wx/gdicmn.h"
+#include "wx/msw/gdiimage.h"
#include "wx/palette.h"
-// Bitmap
-class WXDLLEXPORT wxDC;
-class WXDLLEXPORT wxControl;
-class WXDLLEXPORT wxBitmap;
-class WXDLLEXPORT wxBitmapHandler;
-class WXDLLEXPORT wxIcon;
-class WXDLLEXPORT wxCursor;
-
-// A mask is a mono bitmap used for drawing bitmaps
-// transparently.
-class WXDLLEXPORT wxMask: public wxObject
+class WXDLLIMPEXP_FWD_CORE wxBitmap;
+class WXDLLIMPEXP_FWD_CORE wxBitmapHandler;
+class WXDLLIMPEXP_FWD_CORE wxBitmapRefData;
+class WXDLLIMPEXP_FWD_CORE wxControl;
+class WXDLLIMPEXP_FWD_CORE wxCursor;
+class WXDLLIMPEXP_FWD_CORE wxDC;
+#if wxUSE_WXDIB
+class WXDLLIMPEXP_FWD_CORE wxDIB;
+#endif
+class WXDLLIMPEXP_FWD_CORE wxIcon;
+class WXDLLIMPEXP_FWD_CORE wxImage;
+class WXDLLIMPEXP_FWD_CORE wxMask;
+class WXDLLIMPEXP_FWD_CORE wxPalette;
+class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;
+
+// What kind of transparency should a bitmap copied from an icon or cursor
+// have?
+enum wxBitmapTransparency
{
- DECLARE_DYNAMIC_CLASS(wxMask)
+ wxBitmapTransparency_Auto, // default: copy alpha if the source has it
+ wxBitmapTransparency_None, // never create alpha
+ wxBitmapTransparency_Always // always use alpha
+};
+// ----------------------------------------------------------------------------
+// wxBitmap: a mono or colour bitmap
+// NOTE: for wxMSW we don't use the wxBitmapBase base class declared in bitmap.h!
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxBitmap : public wxGDIImage
+{
public:
- wxMask(void);
+ // default ctor creates an invalid bitmap, you must Create() it later
+ wxBitmap() { }
+
+ // Initialize with raw data
+ wxBitmap(const char bits[], int width, int height, int depth = 1);
+
+ // Initialize with XPM data
+ wxBitmap(const char* const* data);
+#ifdef wxNEEDS_CHARPP
+ wxBitmap(char** data)
+ {
+ *this = wxBitmap(const_cast<const char* const*>(data));
+ }
+#endif
- // Construct a mask from a bitmap and a colour indicating
- // the transparent area
- wxMask(const wxBitmap& bitmap, const wxColour& colour);
+ // Load a file or resource
+ wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
- // Construct a mask from a bitmap and a palette index indicating
- // the transparent area
- wxMask(const wxBitmap& bitmap, int paletteIndex);
+ // New constructor for generalised creation from data
+ wxBitmap(const void* data, wxBitmapType type, int width, int height, int depth = 1);
- // Construct a mask from a mono bitmap (copies the bitmap).
- wxMask(const wxBitmap& bitmap);
+ // Create a new, uninitialized bitmap of the given size and depth (if it
+ // is omitted, will create a bitmap compatible with the display)
+ //
+ // NB: this ctor will create a DIB for 24 and 32bpp bitmaps, use ctor
+ // taking a DC argument if you want to force using DDB in this case
+ wxBitmap(int width, int height, int depth = -1);
- ~wxMask(void);
+ // Create a bitmap compatible with the given DC
+ wxBitmap(int width, int height, const wxDC& dc);
- bool Create(const wxBitmap& bitmap, const wxColour& colour);
- bool Create(const wxBitmap& bitmap, int paletteIndex);
- bool Create(const wxBitmap& bitmap);
+#if wxUSE_IMAGE
+ // Convert from wxImage
+ wxBitmap(const wxImage& image, int depth = -1)
+ { (void)CreateFromImage(image, depth); }
- // Implementation
- inline WXHBITMAP GetMaskBitmap(void) const { return m_maskBitmap; }
- inline void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; }
-protected:
- WXHBITMAP m_maskBitmap;
-};
+ // Create a DDB compatible with the given DC from wxImage
+ wxBitmap(const wxImage& image, const wxDC& dc)
+ { (void)CreateFromImage(image, dc); }
+#endif // wxUSE_IMAGE
-class WXDLLEXPORT wxBitmapRefData: public wxGDIRefData
-{
- friend class WXDLLEXPORT wxBitmap;
- friend class WXDLLEXPORT wxIcon;
- friend class WXDLLEXPORT wxCursor;
-public:
- wxBitmapRefData(void);
- ~wxBitmapRefData(void);
+ // we must have this, otherwise icons are silently copied into bitmaps using
+ // the copy ctor but the resulting bitmap is invalid!
+ wxBitmap(const wxIcon& icon,
+ wxBitmapTransparency transp = wxBitmapTransparency_Auto)
+ {
+ CopyFromIcon(icon, transp);
+ }
-public:
- int m_width;
- int m_height;
- int m_depth;
- bool m_ok;
- int m_numColors;
- wxPalette m_bitmapPalette;
- int m_quality;
-
-#ifdef __WXMSW__
- WXHBITMAP m_hBitmap;
- wxDC * m_selectedInto; // So bitmap knows whether it's been selected into
- // a device context (for error checking)
- wxMask * m_bitmapMask; // Option mask
+ wxBitmap& operator=(const wxIcon& icon)
+ {
+ (void)CopyFromIcon(icon);
+
+ return *this;
+ }
+
+ wxBitmap& operator=(const wxCursor& cursor)
+ {
+ (void)CopyFromCursor(cursor);
+
+ return *this;
+ }
+
+ virtual ~wxBitmap();
+
+#if wxUSE_IMAGE
+ wxImage ConvertToImage() const;
+#endif // wxUSE_IMAGE
+
+ // get the given part of bitmap
+ wxBitmap GetSubBitmap( const wxRect& rect ) const;
+
+ // NB: This should not be called from user code. It is for wx internal
+ // use only.
+ wxBitmap GetSubBitmapOfHDC( const wxRect& rect, WXHDC hdc ) const;
+
+ // copies the contents and mask of the given (colour) icon to the bitmap
+ bool CopyFromIcon(const wxIcon& icon,
+ wxBitmapTransparency transp = wxBitmapTransparency_Auto);
+
+ // copies the contents and mask of the given cursor to the bitmap
+ bool CopyFromCursor(const wxCursor& cursor,
+ wxBitmapTransparency transp = wxBitmapTransparency_Auto);
+
+#if wxUSE_WXDIB
+ // copies from a device independent bitmap
+ bool CopyFromDIB(const wxDIB& dib);
#endif
-};
-#define M_BITMAPDATA ((wxBitmapRefData *)m_refData)
+ virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
+ virtual bool Create(int width, int height, const wxDC& dc);
+ virtual bool Create(const void* data, wxBitmapType type, int width, int height, int depth = 1);
+ virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
+ virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
+
+ wxBitmapRefData *GetBitmapData() const
+ { return (wxBitmapRefData *)m_refData; }
+
+ // raw bitmap access support functions
+ void *GetRawData(wxPixelDataBase& data, int bpp);
+ void UngetRawData(wxPixelDataBase& data);
+
+#if wxUSE_PALETTE
+ wxPalette* GetPalette() const;
+ void SetPalette(const wxPalette& palette);
+#endif // wxUSE_PALETTE
+
+ wxMask *GetMask() const;
+ wxBitmap GetMaskBitmap() const;
+ void SetMask(wxMask *mask);
+
+ // these functions are internal and shouldn't be used, they risk to
+ // disappear in the future
+ bool HasAlpha() const;
+ void UseAlpha();
+
+ // implementation only from now on
+ // -------------------------------
-class WXDLLEXPORT wxBitmapHandler: public wxObject
-{
- DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
public:
- wxBitmapHandler(void) { m_name = ""; m_extension = ""; m_type = 0; };
-
- virtual bool Create(wxBitmap *bitmap, void *data, long flags, int width, int height, int depth = 1);
- virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
- int desiredWidth, int desiredHeight);
- virtual bool SaveFile(wxBitmap *bitmap, const wxString& name, int type, const wxPalette *palette = NULL);
-
- inline void SetName(const wxString& name) { m_name = name; }
- inline void SetExtension(const wxString& ext) { m_extension = ext; }
- inline void SetType(long type) { m_type = type; }
- inline wxString GetName(void) const { return m_name; }
- inline wxString GetExtension(void) const { return m_extension; }
- inline long GetType(void) const { return m_type; }
+ void SetHBITMAP(WXHBITMAP bmp) { SetHandle((WXHANDLE)bmp); }
+ WXHBITMAP GetHBITMAP() const { return (WXHBITMAP)GetHandle(); }
+
+#ifdef __WXDEBUG__
+ void SetSelectedInto(wxDC *dc);
+ wxDC *GetSelectedInto() const;
+#endif // __WXDEBUG__
+
protected:
- wxString m_name;
- wxString m_extension;
- long m_type;
+ virtual wxGDIImageRefData *CreateData() const;
+ virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
+
+ // creates an uninitialized bitmap, called from Create()s above
+ bool DoCreate(int w, int h, int depth, WXHDC hdc);
+
+#if wxUSE_IMAGE
+ // creates the bitmap from wxImage, supposed to be called from ctor
+ bool CreateFromImage(const wxImage& image, int depth);
+
+ // creates a DDB from wxImage, supposed to be called from ctor
+ bool CreateFromImage(const wxImage& image, const wxDC& dc);
+
+ // common part of the 2 methods above (hdc may be 0)
+ bool CreateFromImage(const wxImage& image, int depth, WXHDC hdc);
+#endif // wxUSE_IMAGE
+
+private:
+ // common part of CopyFromIcon/CopyFromCursor for Win32
+ bool
+ CopyFromIconOrCursor(const wxGDIImage& icon,
+ wxBitmapTransparency transp = wxBitmapTransparency_Auto);
+
+
+ DECLARE_DYNAMIC_CLASS(wxBitmap)
};
-#define M_BITMAPHANDLERDATA ((wxBitmapRefData *)bitmap->GetRefData())
-class WXDLLEXPORT wxBitmap: public wxGDIObject
+// ----------------------------------------------------------------------------
+// wxMask: a mono bitmap used for drawing bitmaps transparently.
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxMask : public wxObject
{
- DECLARE_DYNAMIC_CLASS(wxBitmap)
+public:
+ wxMask();
- friend class WXDLLEXPORT wxBitmapHandler;
+ // Copy constructor
+ wxMask(const wxMask &mask);
-public:
- wxBitmap(void); // Platform-specific
+ // Construct a mask from a bitmap and a colour indicating the transparent
+ // area
+ wxMask(const wxBitmap& bitmap, const wxColour& colour);
- // Copy constructors
- inline wxBitmap(const wxBitmap& bitmap)
- { Ref(bitmap); if ( wxTheBitmapList ) wxTheBitmapList->AddBitmap(this); }
- inline wxBitmap(const wxBitmap* bitmap) { if (bitmap) Ref(*bitmap); if ( wxTheBitmapList ) wxTheBitmapList->AddBitmap(this); }
+ // Construct a mask from a bitmap and a palette index indicating the
+ // transparent area
+ wxMask(const wxBitmap& bitmap, int paletteIndex);
- // Initialize with raw data
- wxBitmap(const char bits[], int width, int height, int depth = 1);
+ // Construct a mask from a mono bitmap (copies the bitmap).
+ wxMask(const wxBitmap& bitmap);
-#if wxUSE_XPM_IN_MSW
- class wxItem;
- // Initialize with XPM data
- wxBitmap(const char **data, wxItem *anItem = NULL);
-#endif
+ // construct a mask from the givne bitmap handle
+ wxMask(WXHBITMAP hbmp) { m_maskBitmap = hbmp; }
+
+ virtual ~wxMask();
+
+ bool Create(const wxBitmap& bitmap, const wxColour& colour);
+ bool Create(const wxBitmap& bitmap, int paletteIndex);
+ bool Create(const wxBitmap& bitmap);
+
+ // Implementation
+ WXHBITMAP GetMaskBitmap() const { return m_maskBitmap; }
+ void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; }
- // Load a file or resource
- wxBitmap(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE);
-
- // New constructor for generalised creation from data
- wxBitmap(void *data, long type, int width, int height, int depth = 1);
-
- // If depth is omitted, will create a bitmap compatible with the display
- wxBitmap(int width, int height, int depth = -1);
- ~wxBitmap(void);
-
- virtual bool Create(int width, int height, int depth = -1);
- virtual bool Create(void *data, long type, int width, int height, int depth = 1);
- virtual bool LoadFile(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE);
- virtual bool SaveFile(const wxString& name, int type, const wxPalette *cmap = NULL);
-
- inline bool Ok(void) const { return (M_BITMAPDATA && M_BITMAPDATA->m_ok); }
- inline int GetWidth(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_width : 0); }
- inline int GetHeight(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_height : 0); }
- inline int GetDepth(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_depth : 0); }
- inline int GetQuality(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_quality : 0); }
- void SetWidth(int w);
- void SetHeight(int h);
- void SetDepth(int d);
- void SetQuality(int q);
- void SetOk(bool isOk);
-#if WXWIN_COMPATIBILITY
- inline wxPalette *GetColourMap(void) const { return GetPalette(); }
- void SetColourMap(wxPalette *cmap) { SetPalette(*cmap); };
-#endif
- inline wxPalette* GetPalette(void) const { return (M_BITMAPDATA ? (& M_BITMAPDATA->m_bitmapPalette) : NULL); }
- void SetPalette(const wxPalette& palette);
-
- inline wxMask *GetMask(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_bitmapMask : NULL); }
- void SetMask(wxMask *mask) ;
-
- inline wxBitmap& operator = (const wxBitmap& bitmap) { if (*this == bitmap) return (*this); Ref(bitmap); return *this; }
- inline bool operator == (const wxBitmap& bitmap) { return m_refData == bitmap.m_refData; }
- inline bool operator != (const wxBitmap& bitmap) { return m_refData != bitmap.m_refData; }
-
- // Format handling
- static inline wxList& GetHandlers(void) { return sm_handlers; }
- static void AddHandler(wxBitmapHandler *handler);
- static void InsertHandler(wxBitmapHandler *handler);
- static bool RemoveHandler(const wxString& name);
- static wxBitmapHandler *FindHandler(const wxString& name);
- static wxBitmapHandler *FindHandler(const wxString& extension, long bitmapType);
- static wxBitmapHandler *FindHandler(long bitmapType);
-
- static void InitStandardHandlers(void);
- static void CleanUpHandlers(void);
protected:
- static wxList sm_handlers;
+ WXHBITMAP m_maskBitmap;
- // Implementation
-public:
- void SetHBITMAP(WXHBITMAP bmp);
- inline WXHBITMAP GetHBITMAP(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_hBitmap : 0); }
- inline void SetSelectedInto(wxDC *dc) { if (M_BITMAPDATA) M_BITMAPDATA->m_selectedInto = dc; }
- inline wxDC *GetSelectedInto(void) const { return (M_BITMAPDATA ? M_BITMAPDATA->m_selectedInto : NULL); }
- bool FreeResource(bool force = FALSE);
-
- // Creates a bitmap that matches the device context's depth, from
- // an arbitray bitmap. At present, the original bitmap must have an
- // associated palette. (TODO: use a default palette if no palette exists.)
- // This function is necessary for you to Blit an arbitrary bitmap (which may have
- // the wrong depth). wxDC::SelectObject will compare the depth of the bitmap
- // with the DC's depth, and create a new bitmap if the depths differ.
- // Eventually we should perhaps make this a public API function so that
- // an app can efficiently produce bitmaps of the correct depth.
- // The Windows solution is to use SetDibBits to blit an arbotrary DIB directly to a DC, but
- // this is too Windows-specific, hence this solution of quietly converting the wxBitmap.
- // Contributed by Frederic Villeneuve <frederic.villeneuve@natinst.com>
- wxBitmap GetBitmapForDC(wxDC& dc) const;
+ DECLARE_DYNAMIC_CLASS(wxMask)
+};
+
+
+// ----------------------------------------------------------------------------
+// wxBitmapHandler is a class which knows how to load/save bitmaps to/from file
+// NOTE: for wxMSW we don't use the wxBitmapHandler class declared in bitmap.h!
+// ----------------------------------------------------------------------------
+class WXDLLIMPEXP_CORE wxBitmapHandler : public wxGDIImageHandler
+{
+public:
+ wxBitmapHandler() { }
+ wxBitmapHandler(const wxString& name, const wxString& ext, wxBitmapType type)
+ : wxGDIImageHandler(name, ext, type) { }
+
+ // implement wxGDIImageHandler's pure virtuals:
+
+ virtual bool Create(wxGDIImage *image,
+ const void* data,
+ wxBitmapType type,
+ int width, int height, int depth = 1);
+ virtual bool Load(wxGDIImage *image,
+ const wxString& name,
+ wxBitmapType type,
+ int desiredWidth, int desiredHeight);
+ virtual bool Save(const wxGDIImage *image,
+ const wxString& name,
+ wxBitmapType type) const;
+
+
+ // make wxBitmapHandler compatible with the wxBitmapHandler interface
+ // declared in bitmap.h, even if it's derived from wxGDIImageHandler:
+
+ virtual bool Create(wxBitmap *bitmap,
+ const void* data,
+ wxBitmapType type,
+ int width, int height, int depth = 1);
+ virtual bool LoadFile(wxBitmap *bitmap,
+ const wxString& name,
+ wxBitmapType type,
+ int desiredWidth, int desiredHeight);
+ virtual bool SaveFile(const wxBitmap *bitmap,
+ const wxString& name,
+ wxBitmapType type,
+ const wxPalette *palette = NULL) const;
+
+private:
+ DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
};
+
#endif
// _WX_BITMAP_H_
projects / wxWidgets.git / blobdiff