X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/87f83ac8676d83b1bc75cbb0a6b4cf612f86bc2b..e733c4ce1e24cf7e4b0b0d8362fc59aaa7a7641c:/include/wx/bitmap.h diff --git a/include/wx/bitmap.h b/include/wx/bitmap.h index 0b5da2e630..6d9ffe71b7 100644 --- a/include/wx/bitmap.h +++ b/include/wx/bitmap.h @@ -4,7 +4,6 @@ // Author: Vaclav Slavik // Modified by: // Created: 22.04.01 -// RCS-ID: $Id$ // Copyright: (c) wxWidgets team // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// @@ -16,24 +15,34 @@ // headers // ---------------------------------------------------------------------------- -#include "wx/defs.h" -#include "wx/object.h" #include "wx/string.h" -#include "wx/gdiobj.h" #include "wx/gdicmn.h" // for wxBitmapType +#include "wx/colour.h" +#include "wx/image.h" -class WXDLLEXPORT wxBitmap; -class WXDLLEXPORT wxBitmapHandler; -class WXDLLEXPORT wxIcon; -class WXDLLEXPORT wxImage; -class WXDLLEXPORT wxMask; -class WXDLLEXPORT wxPalette; +class WXDLLIMPEXP_FWD_CORE wxBitmap; +class WXDLLIMPEXP_FWD_CORE wxBitmapHandler; +class WXDLLIMPEXP_FWD_CORE wxIcon; +class WXDLLIMPEXP_FWD_CORE wxMask; +class WXDLLIMPEXP_FWD_CORE wxPalette; +class WXDLLIMPEXP_FWD_CORE wxDC; + +// ---------------------------------------------------------------------------- +// wxVariant support +// ---------------------------------------------------------------------------- + +#if wxUSE_VARIANT +#include "wx/variant.h" +DECLARE_VARIANT_OBJECT_EXPORTED(wxBitmap,WXDLLIMPEXP_CORE) +#endif // ---------------------------------------------------------------------------- // wxMask represents the transparent area of the bitmap // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxMaskBase : public wxObject +// TODO: all implementation of wxMask, except the generic one, +// do not derive from wxMaskBase,,, they should +class WXDLLIMPEXP_CORE wxMaskBase : public wxObject { public: // create the mask from bitmap pixels of the given colour @@ -59,8 +68,7 @@ protected: virtual bool InitFromMonoBitmap(const wxBitmap& bitmap) = 0; }; -#if defined(__WXMGL__) || \ - defined(__WXDFB__) || \ +#if defined(__WXDFB__) || \ defined(__WXMAC__) || \ defined(__WXGTK__) || \ defined(__WXCOCOA__) || \ @@ -71,8 +79,30 @@ protected: #define wxUSE_BITMAP_BASE 0 #endif -// Only used by some ports -// FIXME -- make all ports (but MSW which uses wxGDIImage) use these base classes +// a more readable way to tell +#define wxBITMAP_SCREEN_DEPTH (-1) + + +// ---------------------------------------------------------------------------- +// wxBitmapHelpers: container for various bitmap methods common to all ports. +// ---------------------------------------------------------------------------- + +// Unfortunately, currently wxBitmap does not inherit from wxBitmapBase on all +// platforms and this is not easy to fix. So we extract at least some common +// methods into this class from which both wxBitmapBase (and hence wxBitmap on +// all platforms where it does inherit from it) and wxBitmap in wxMSW and other +// exceptional ports (only wxPM and old wxCocoa) inherit. +class WXDLLIMPEXP_CORE wxBitmapHelpers +{ +public: + // Create a new wxBitmap from the PNG data in the given buffer. + static wxBitmap NewFromPNGData(const void* data, size_t size); +}; + + +// All ports except wxMSW and wxOS2 use wxBitmapHandler and wxBitmapBase as +// base class for wxBitmapHandler; wxMSW and wxOS2 use wxGDIImageHandler as +// base class since it allows some code reuse there. #if wxUSE_BITMAP_BASE // ---------------------------------------------------------------------------- @@ -80,29 +110,35 @@ protected: // different formats // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxBitmapHandlerBase : public wxObject +class WXDLLIMPEXP_CORE wxBitmapHandler : public wxObject { public: - wxBitmapHandlerBase() - : m_name() - , m_extension() - , m_type(wxBITMAP_TYPE_INVALID) - { } + wxBitmapHandler() { m_type = wxBITMAP_TYPE_INVALID; } + virtual ~wxBitmapHandler() { } + + // NOTE: the following functions should be pure virtuals, but they aren't + // because otherwise almost all ports would have to implement + // them as "return false"... - virtual ~wxBitmapHandlerBase() { } + virtual bool Create(wxBitmap *WXUNUSED(bitmap), const void* WXUNUSED(data), + wxBitmapType WXUNUSED(type), int WXUNUSED(width), int WXUNUSED(height), + int WXUNUSED(depth) = 1) + { return false; } - virtual bool Create(wxBitmap *bitmap, void *data, long flags, - int width, int height, int depth = 1) = 0; - virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags, - int desiredWidth, int desiredHeight) = 0; - virtual bool SaveFile(const wxBitmap *bitmap, const wxString& name, - int type, const wxPalette *palette = NULL) = 0; + virtual bool LoadFile(wxBitmap *WXUNUSED(bitmap), const wxString& WXUNUSED(name), + wxBitmapType WXUNUSED(type), int WXUNUSED(desiredWidth), + int WXUNUSED(desiredHeight)) + { return false; } + + virtual bool SaveFile(const wxBitmap *WXUNUSED(bitmap), const wxString& WXUNUSED(name), + wxBitmapType WXUNUSED(type), const wxPalette *WXUNUSED(palette) = NULL) const + { return false; } void SetName(const wxString& name) { m_name = name; } void SetExtension(const wxString& ext) { m_extension = ext; } void SetType(wxBitmapType type) { m_type = type; } - wxString GetName() const { return m_name; } - wxString GetExtension() const { return m_extension; } + const wxString& GetName() const { return m_name; } + const wxString& GetExtension() const { return m_extension; } wxBitmapType GetType() const { return m_type; } private: @@ -110,46 +146,65 @@ private: wxString m_extension; wxBitmapType m_type; -private: - DECLARE_ABSTRACT_CLASS(wxBitmapHandlerBase) + DECLARE_ABSTRACT_CLASS(wxBitmapHandler) }; -class WXDLLEXPORT wxBitmapBase : public wxGDIObject +// ---------------------------------------------------------------------------- +// wxBitmap: class which represents platform-dependent bitmap (unlike wxImage) +// ---------------------------------------------------------------------------- + +class WXDLLIMPEXP_CORE wxBitmapBase : public wxGDIObject, + public wxBitmapHelpers { public: /* Derived class must implement these: wxBitmap(); - wxBitmap(int width, int height, int depth = -1); + wxBitmap(const wxBitmap& bmp); wxBitmap(const char bits[], int width, int height, int depth = 1); - wxBitmap(const char **bits); - wxBitmap(char **bits); + wxBitmap(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH); + wxBitmap(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH); + wxBitmap(const char* const* bits); wxBitmap(const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM); - wxBitmap(const wxImage& image, int depth = -1); - bool operator == (const wxBitmap& bmp) const; - bool operator != (const wxBitmap& bmp) const; - - bool Create(int width, int height, int depth = -1); + wxBitmap(const wxImage& image, int depth = wxBITMAP_SCREEN_DEPTH); static void InitStandardHandlers(); */ - virtual bool Ok() const = 0; + virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH) = 0; + virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH) = 0; + virtual bool CreateScaled(int w, int h, int d, double logicalScale) + { return Create(w*logicalScale,h*logicalScale,d); } virtual int GetHeight() const = 0; virtual int GetWidth() const = 0; virtual int GetDepth() const = 0; + wxSize GetSize() const + { return wxSize(GetWidth(), GetHeight()); } + + // support for scaled bitmaps + virtual double GetScaleFactor() const { return 1.0; } + virtual double GetScaledWidth() const { return GetWidth() / GetScaleFactor(); } + virtual double GetScaledHeight() const { return GetHeight() / GetScaleFactor(); } + virtual wxSize GetScaledSize() const + { return wxSize(GetScaledWidth(), GetScaledHeight()); } + +#if wxUSE_IMAGE virtual wxImage ConvertToImage() const = 0; + // Convert to disabled (dimmed) bitmap. + wxBitmap ConvertToDisabled(unsigned char brightness = 255) const; +#endif // wxUSE_IMAGE + virtual wxMask *GetMask() const = 0; virtual void SetMask(wxMask *mask) = 0; virtual wxBitmap GetSubBitmap(const wxRect& rect) const = 0; virtual bool SaveFile(const wxString &name, wxBitmapType type, - const wxPalette *palette = (wxPalette *)NULL) const = 0; + const wxPalette *palette = NULL) const = 0; virtual bool LoadFile(const wxString &name, wxBitmapType type) = 0; /* @@ -175,8 +230,8 @@ public: // Format handling static inline wxList& GetHandlers() { return sm_handlers; } - static void AddHandler(wxBitmapHandlerBase *handler); - static void InsertHandler(wxBitmapHandlerBase *handler); + 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, wxBitmapType bitmapType); @@ -204,32 +259,58 @@ protected: #endif // wxUSE_BITMAP_BASE -#if defined(__WXPALMOS__) - #include "wx/palmos/bitmap.h" -#elif defined(__WXMSW__) + +// the wxBITMAP_DEFAULT_TYPE constant defines the default argument value +// for wxBitmap's ctor and wxBitmap::LoadFile() functions. +#if defined(__WXMSW__) + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE #include "wx/msw/bitmap.h" #elif defined(__WXMOTIF__) + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM #include "wx/x11/bitmap.h" #elif defined(__WXGTK20__) + #ifdef __WINDOWS__ + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE + #else + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM + #endif #include "wx/gtk/bitmap.h" #elif defined(__WXGTK__) + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM #include "wx/gtk1/bitmap.h" #elif defined(__WXX11__) + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM #include "wx/x11/bitmap.h" -#elif defined(__WXMGL__) - #include "wx/mgl/bitmap.h" #elif defined(__WXDFB__) + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE #include "wx/dfb/bitmap.h" #elif defined(__WXMAC__) - #include "wx/mac/bitmap.h" + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_PICT_RESOURCE + #include "wx/osx/bitmap.h" #elif defined(__WXCOCOA__) + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE #include "wx/cocoa/bitmap.h" #elif defined(__WXPM__) + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE #include "wx/os2/bitmap.h" #endif +#if wxUSE_IMAGE +inline +wxBitmap +#if wxUSE_BITMAP_BASE +wxBitmapBase:: +#else +wxBitmap:: +#endif +ConvertToDisabled(unsigned char brightness) const +{ + return ConvertToImage().ConvertToDisabled(brightness); +} +#endif // wxUSE_IMAGE + // we must include generic mask.h after wxBitmap definition -#if defined(__WXMGL__) || defined(__WXDFB__) +#if defined(__WXDFB__) #define wxUSE_GENERIC_MASK 1 #else #define wxUSE_GENERIC_MASK 0