X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1be7a35c5ec31b6cfcab9d969c7969586441a945..43ff861df48f0837dac98005dd397c5f127ca136:/include/wx/bitmap.h diff --git a/include/wx/bitmap.h b/include/wx/bitmap.h index b853687661..754eabc631 100644 --- a/include/wx/bitmap.h +++ b/include/wx/bitmap.h @@ -16,55 +16,113 @@ // 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 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; + +// ---------------------------------------------------------------------------- +// 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 +// ---------------------------------------------------------------------------- + +// 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 + bool Create(const wxBitmap& bitmap, const wxColour& colour); + +#if wxUSE_PALETTE + // create the mask from bitmap pixels with the given palette index + bool Create(const wxBitmap& bitmap, int paletteIndex); +#endif // wxUSE_PALETTE + + // create the mask from the given mono bitmap + bool Create(const wxBitmap& bitmap); + +protected: + // this function is called from Create() to free the existing mask data + virtual void FreeData() = 0; + + // these functions must be overridden to implement the corresponding public + // Create() methods, they shouldn't call FreeData() as it's already called + // by the public wrappers + virtual bool InitFromColour(const wxBitmap& bitmap, + const wxColour& colour) = 0; + virtual bool InitFromMonoBitmap(const wxBitmap& bitmap) = 0; +}; #if defined(__WXMGL__) || \ + defined(__WXDFB__) || \ defined(__WXMAC__) || \ defined(__WXGTK__) || \ defined(__WXCOCOA__) || \ defined(__WXMOTIF__) || \ defined(__WXX11__) -// Only used by some ports -// FIXME -- make all ports (but MSW which uses wxGDIImage) use these base classes + #define wxUSE_BITMAP_BASE 1 +#else + #define wxUSE_BITMAP_BASE 0 +#endif + +// a more readable way to tell +#define wxBITMAP_SCREEN_DEPTH (-1) + + +// All ports except wxMSW,wxOS2,wxPalmOS use wxBitmapHandler and wxBitmapBase as base class +// for wxBitmapHandler; wxMSW,wxOS2,wxPalmOS use wxGDIImageHandler as base class +// since it allows some code reuse there. +#if wxUSE_BITMAP_BASE // ---------------------------------------------------------------------------- // wxBitmapHandler: class which knows how to create/load/save bitmaps in // 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() { } - virtual ~wxBitmapHandlerBase() { } + // 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 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 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 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: @@ -72,51 +130,56 @@ 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: - wxBitmapBase() : wxGDIObject() {} - virtual ~wxBitmapBase() {} - /* Derived class must implement these: wxBitmap(); - wxBitmap(int width, int height, int depth = -1); - wxBitmap(const char bits[], int width, int height, int depth = 1); - wxBitmap(const char **bits); - wxBitmap(char **bits); wxBitmap(const wxBitmap& bmp); + wxBitmap(const char bits[], int width, int height, int depth = 1); + 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); - wxBitmap& operator = (const wxBitmap& bmp); - 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 int GetHeight() const = 0; virtual int GetWidth() const = 0; virtual int GetDepth() const = 0; + wxSize GetSize() const + { return wxSize(GetWidth(), GetHeight()); } + +#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; /* @@ -142,8 +205,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); @@ -154,34 +217,84 @@ public: static void CleanUpHandlers(); + // this method is only used by the generic implementation of wxMask + // currently but could be useful elsewhere in the future: it can be + // overridden to quantize the colour to correspond to bitmap colour depth + // if necessary; default implementation simply returns the colour as is + virtual wxColour QuantizeColour(const wxColour& colour) const + { + return colour; + } + protected: static wxList sm_handlers; DECLARE_ABSTRACT_CLASS(wxBitmapBase) }; -#endif +#endif // wxUSE_BITMAP_BASE + + +// the wxBITMAP_DEFAULT_TYPE constant defines the default argument value +// for wxBitmap's ctor and wxBitmap::LoadFile() functions. #if defined(__WXPALMOS__) -#include "wx/palmos/bitmap.h" + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE + #include "wx/palmos/bitmap.h" #elif defined(__WXMSW__) -#include "wx/msw/bitmap.h" + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE + #include "wx/msw/bitmap.h" #elif defined(__WXMOTIF__) -#include "wx/x11/bitmap.h" + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM + #include "wx/x11/bitmap.h" #elif defined(__WXGTK20__) -#include "wx/gtk/bitmap.h" + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM + #include "wx/gtk/bitmap.h" #elif defined(__WXGTK__) -#include "wx/gtk1/bitmap.h" + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM + #include "wx/gtk1/bitmap.h" #elif defined(__WXX11__) -#include "wx/x11/bitmap.h" + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM + #include "wx/x11/bitmap.h" #elif defined(__WXMGL__) -#include "wx/mgl/bitmap.h" + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_RESOURCE + #include "wx/mgl/bitmap.h" +#elif defined(__WXDFB__) + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_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__) -#include "wx/cocoa/bitmap.h" + #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE + #include "wx/cocoa/bitmap.h" #elif defined(__WXPM__) -#include "wx/os2/bitmap.h" + #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 - // _WX_BITMAP_H_BASE_ +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__) + #define wxUSE_GENERIC_MASK 1 +#else + #define wxUSE_GENERIC_MASK 0 +#endif + +#if wxUSE_GENERIC_MASK + #include "wx/generic/mask.h" +#endif + +#endif // _WX_BITMAP_H_BASE_