// Created: 01/02/97
// RCS-ID: $Id$
// Copyright: (c) Julian Smart
-// Licence: wxWidgets licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_BITMAP_H_
#define _WX_BITMAP_H_
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #pragma interface "bitmap.h"
-#endif
-
#include "wx/msw/gdiimage.h"
-#include "wx/gdicmn.h"
#include "wx/palette.h"
-class WXDLLEXPORT wxBitmap;
-class WXDLLEXPORT wxBitmapHandler;
-class WXDLLEXPORT wxBitmapRefData;
-class WXDLLEXPORT wxControl;
-class WXDLLEXPORT wxCursor;
-class WXDLLEXPORT wxDC;
+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 WXDLLEXPORT wxDIB;
+class WXDLLIMPEXP_FWD_CORE wxDIB;
#endif
-class WXDLLEXPORT wxIcon;
-class WXDLLEXPORT wxImage;
-class WXDLLEXPORT wxMask;
-class WXDLLEXPORT wxPalette;
-class WXDLLEXPORT wxPixelDataBase;
+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
+{
+ 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
{
public:
// default ctor creates an invalid bitmap, you must Create() it later
- wxBitmap() { Init(); }
-
- // Copy constructors
- wxBitmap(const wxBitmap& bitmap) { Init(); Ref(bitmap); }
+ wxBitmap() { }
// Initialize with raw data
wxBitmap(const char bits[], int width, int height, int depth = 1);
// Initialize with XPM data
- wxBitmap(const char **data) { CreateFromXpm(data); }
- wxBitmap(char **data) { CreateFromXpm((const char **)data); }
+ wxBitmap(const char* const* data);
+#ifdef wxNEEDS_CHARPP
+ wxBitmap(char** data)
+ {
+ *this = wxBitmap(wx_const_cast(const char* const*, data));
+ }
+#endif
// Load a file or resource
wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
// New constructor for generalised creation from data
- wxBitmap(void *data, long type, int width, int height, int depth = 1);
+ wxBitmap(const void* data, long type, int width, int height, int depth = 1);
// Create a new, uninitialized bitmap of the given size and depth (if it
// is omitted, will create a bitmap compatible with the display)
// Create a bitmap compatible with the given DC
wxBitmap(int width, int height, const wxDC& dc);
-#if wxUSE_IMAGE && wxUSE_WXDIB
+#if wxUSE_IMAGE
// Convert from wxImage
wxBitmap(const wxImage& image, int depth = -1)
{ (void)CreateFromImage(image, depth); }
// 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) { Init(); CopyFromIcon(icon); }
-
- wxBitmap& operator=(const wxBitmap& bitmap)
+ wxBitmap(const wxIcon& icon,
+ wxBitmapTransparency transp = wxBitmapTransparency_Auto)
{
- if ( m_refData != bitmap.m_refData )
- Ref(bitmap);
- return *this;
+ CopyFromIcon(icon, transp);
}
wxBitmap& operator=(const wxIcon& icon)
virtual ~wxBitmap();
-#if wxUSE_IMAGE && wxUSE_WXDIB
+#if wxUSE_IMAGE
wxImage ConvertToImage() const;
#endif // wxUSE_IMAGE
wxBitmap GetSubBitmap( const wxRect& rect ) const;
// copies the contents and mask of the given (colour) icon to the bitmap
- bool CopyFromIcon(const wxIcon& icon);
+ 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);
+ bool CopyFromCursor(const wxCursor& cursor,
+ wxBitmapTransparency transp = wxBitmapTransparency_Auto);
#if wxUSE_WXDIB
// copies from a device independent bitmap
virtual bool Create(int width, int height, int depth = -1);
virtual bool Create(int width, int height, const wxDC& dc);
- virtual bool Create(void *data, long type, int width, int height, int depth = 1);
+ virtual bool Create(const 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);
#endif // wxUSE_PALETTE
wxMask *GetMask() const;
+ wxBitmap GetMaskBitmap() const;
void SetMask(wxMask *mask);
- bool operator==(const wxBitmap& bitmap) const { return m_refData == bitmap.m_refData; }
- bool operator!=(const wxBitmap& bitmap) const { return m_refData != bitmap.m_refData; }
-
// these functions are internal and shouldn't be used, they risk to
// disappear in the future
bool HasAlpha() const;
void UseAlpha();
-#if WXWIN_COMPATIBILITY_2_4
- // these functions do nothing and are only there for backwards
- // compatibility
- wxDEPRECATED( int GetQuality() const );
- wxDEPRECATED( void SetQuality(int quality) );
-#endif // WXWIN_COMPATIBILITY_2_4
-
// implementation only from now on
// -------------------------------
#endif // __WXDEBUG__
protected:
- // common part of all ctors
- void Init();
-
virtual wxGDIImageRefData *CreateData() const;
-
- // creates the bitmap from XPM data, supposed to be called from ctor
- bool CreateFromXpm(const char **bits);
+ virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
// creates an uninitialized bitmap, called from Create()s above
bool DoCreate(int w, int h, int depth, WXHDC hdc);
-#if wxUSE_IMAGE && wxUSE_WXDIB
+#if wxUSE_IMAGE
// creates the bitmap from wxImage, supposed to be called from ctor
bool CreateFromImage(const wxImage& image, int depth);
#endif // wxUSE_IMAGE
private:
-#ifdef __WIN32__
// common part of CopyFromIcon/CopyFromCursor for Win32
- bool CopyFromIconOrCursor(const wxGDIImage& icon);
-#endif // __WIN32__
+ bool
+ CopyFromIconOrCursor(const wxGDIImage& icon,
+ wxBitmapTransparency transp = wxBitmapTransparency_Auto);
+
DECLARE_DYNAMIC_CLASS(wxBitmap)
};
public:
wxMask();
+ // Copy constructor
+ wxMask(const wxMask &mask);
+
// Construct a mask from a bitmap and a colour indicating the transparent
// area
wxMask(const wxBitmap& bitmap, const wxColour& colour);
class WXDLLEXPORT wxBitmapHandler : public wxGDIImageHandler
{
public:
- wxBitmapHandler() { m_type = wxBITMAP_TYPE_INVALID; }
+ wxBitmapHandler() { }
wxBitmapHandler(const wxString& name, const wxString& ext, long type)
: wxGDIImageHandler(name, ext, type)
{
// keep wxBitmapHandler derived from wxGDIImageHandler compatible with the
// old class which worked only with bitmaps
virtual bool Create(wxBitmap *bitmap,
- void *data,
+ const void* data,
long flags,
int width, int height, int depth = 1);
virtual bool LoadFile(wxBitmap *bitmap,
const wxPalette *palette = NULL);
virtual bool Create(wxGDIImage *image,
- void *data,
+ const void* data,
long flags,
int width, int height, int depth = 1);
virtual bool Load(wxGDIImage *image,
projects / wxWidgets.git / blobdiff