X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d7363643153581c9b8869697403715d6840189a3..c15521c67eb8aba1994240262ba973aa11ef0086:/include/wx/msw/bitmap.h diff --git a/include/wx/msw/bitmap.h b/include/wx/msw/bitmap.h index 650d75c4d4..dff632bbb3 100644 --- a/include/wx/msw/bitmap.h +++ b/include/wx/msw/bitmap.h @@ -1,202 +1,305 @@ ///////////////////////////////////////////////////////////////////////////// -// 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 and Markus Holzem -// Licence: wxWindows license +// Copyright: (c) Julian Smart +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifndef __BITMAPH__ -#define __BITMAPH__ +#ifndef _WX_BITMAP_H_ +#define _WX_BITMAP_H_ #ifdef __GNUG__ -#pragma interface "bitmap.h" + #pragma interface "bitmap.h" #endif -#include "wx/gdiobj.h" +#include "wx/msw/gdiimage.h" #include "wx/gdicmn.h" #include "wx/palette.h" -// Bitmap class WXDLLEXPORT wxDC; class WXDLLEXPORT wxControl; class WXDLLEXPORT wxBitmap; class WXDLLEXPORT wxBitmapHandler; class WXDLLEXPORT wxIcon; +class WXDLLEXPORT wxMask; class WXDLLEXPORT wxCursor; +class WXDLLEXPORT wxControl; +class WXDLLEXPORT wxImage; +class WXDLLEXPORT wxPalette; + +// ---------------------------------------------------------------------------- +// Bitmap data +// +// NB: this class is private, but declared here to make it possible inline +// wxBitmap functions accessing it +// ---------------------------------------------------------------------------- -// A mask is a mono bitmap used for drawing bitmaps -// transparently. -class WXDLLEXPORT wxMask: public wxObject +class WXDLLEXPORT wxBitmapRefData : public wxGDIImageRefData { - DECLARE_DYNAMIC_CLASS(wxMask) +public: + wxBitmapRefData(); + virtual ~wxBitmapRefData() { Free(); } + + virtual void Free(); public: - wxMask(void); + int m_numColors; +#if wxUSE_PALETTE + wxPalette m_bitmapPalette; +#endif // wxUSE_PALETTE + int m_quality; + + // MSW-specific + // ------------ + + // this field is solely for error checking: we detect selecting a bitmap + // into more than one DC at once or deleting a bitmap still selected into a + // DC (both are serious programming errors under Windows) + wxDC *m_selectedInto; + + // optional mask for transparent drawing + wxMask *m_bitmapMask; +}; - // Construct a mask from a bitmap and a colour indicating - // the transparent area - wxMask(const wxBitmap& bitmap, const wxColour& colour); +// ---------------------------------------------------------------------------- +// wxBitmap: a mono or colour bitmap +// ---------------------------------------------------------------------------- - // Construct a mask from a bitmap and a palette index indicating - // the transparent area - wxMask(const wxBitmap& bitmap, const int paletteIndex); +class WXDLLEXPORT wxBitmap : public wxGDIImage +{ +public: + // default ctor creates an invalid bitmap, you must Create() it later + wxBitmap() { Init(); } - // Construct a mask from a mono bitmap (copies the bitmap). - wxMask(const wxBitmap& bitmap); + // Copy constructors + wxBitmap(const wxBitmap& bitmap) { Init(); Ref(bitmap); } - ~wxMask(void); + // Initialize with raw data + wxBitmap(const char bits[], int width, int height, int depth = 1); - bool Create(const wxBitmap& bitmap, const wxColour& colour); - bool Create(const wxBitmap& bitmap, const int paletteIndex); - bool Create(const wxBitmap& bitmap); + // Initialize with XPM data + wxBitmap(const char **data) { CreateFromXpm(data); } + wxBitmap(char **data) { CreateFromXpm((const char **)data); } - // Implementation - inline WXHBITMAP GetMaskBitmap(void) const { return m_maskBitmap; } - inline void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; } -protected: - WXHBITMAP m_maskBitmap; -}; + // Load a file or resource + wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE); -class WXDLLEXPORT wxBitmapRefData: public wxGDIRefData -{ - friend class WXDLLEXPORT wxBitmap; - friend class WXDLLEXPORT wxIcon; - friend class WXDLLEXPORT wxCursor; -public: - wxBitmapRefData(void); - ~wxBitmapRefData(void); + // New constructor for generalised creation from data + wxBitmap(void *data, long type, int width, int height, int depth = 1); -public: - int m_width; - int m_height; - int m_depth; - bool m_ok; - int m_numColors; - wxPalette m_bitmapPalette; - int m_quality; - -#ifdef __WINDOWS__ - 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 -#endif -}; + // If depth is omitted, will create a bitmap compatible with the display + wxBitmap(int width, int height, int depth = -1); -#define M_BITMAPDATA ((wxBitmapRefData *)m_refData) +#if wxUSE_IMAGE + // Convert from wxImage: + wxBitmap(const wxImage& image, int depth = -1) + { (void)CreateFromImage(image, depth); } +#endif // wxUSE_IMAGE -class WXDLLEXPORT wxBitmapHandler: public wxObject -{ - DECLARE_DYNAMIC_CLASS(wxBitmapHandler) + // 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) + { + if ( m_refData != bitmap.m_refData ) + Ref(bitmap); + return *this; + } + + 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; + + // copies the contents and mask of the given (colour) icon to the bitmap + bool CopyFromIcon(const wxIcon& icon); + + // copies the contents and mask of the given cursor to the bitmap + bool CopyFromCursor(const wxCursor& cursor); + + 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); + + wxBitmapRefData *GetBitmapData() const { return (wxBitmapRefData *)m_refData; } + + int GetQuality() const { return (GetBitmapData() ? GetBitmapData()->m_quality : 0); } + void SetQuality(int q); + +#if wxUSE_PALETTE + wxPalette* GetPalette() const { return (GetBitmapData() ? (& GetBitmapData()->m_bitmapPalette) : (wxPalette*) NULL); } + void SetPalette(const wxPalette& palette); +#endif // wxUSE_PALETTE + + wxMask *GetMask() const { return (GetBitmapData() ? GetBitmapData()->m_bitmapMask : (wxMask*) NULL); } + 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; } + +#if WXWIN_COMPATIBILITY_2 + void SetOk(bool isOk); +#endif // WXWIN_COMPATIBILITY_2 + +#if wxUSE_PALETTE +#if WXWIN_COMPATIBILITY + wxPalette *GetColourMap() const { return GetPalette(); } + void SetColourMap(wxPalette *cmap) { SetPalette(*cmap); }; +#endif // WXWIN_COMPATIBILITY +#endif // wxUSE_PALETTE + + // Implementation public: - wxBitmapHandler(void) { m_name = ""; m_extension = ""; m_type = 0; }; - - virtual bool Create(wxBitmap *bitmap, void *data, const long flags, const int width, const int height, const int depth = 1); - virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, const long flags, - int desiredWidth, int desiredHeight); - virtual bool SaveFile(wxBitmap *bitmap, const wxString& name, const 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(const 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(); } + + void SetSelectedInto(wxDC *dc) { if (GetBitmapData()) GetBitmapData()->m_selectedInto = dc; } + wxDC *GetSelectedInto() const { return (GetBitmapData() ? GetBitmapData()->m_selectedInto : (wxDC*) NULL); } + + // 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 + // + wxBitmap GetBitmapForDC(wxDC& dc) const; + protected: - wxString m_name; - wxString m_extension; - long m_type; + // common part of all ctors + void Init(); + + virtual wxGDIImageRefData *CreateData() const + { return new wxBitmapRefData; } + + // creates the bitmap from XPM data, supposed to be called from ctor + bool CreateFromXpm(const char **bits); + +#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__ + + 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 WXDLLEXPORT wxMask : public wxObject { - DECLARE_DYNAMIC_CLASS(wxBitmap) +public: + wxMask(); - friend class WXDLLEXPORT wxBitmapHandler; + // Construct a mask from a bitmap and a colour indicating the transparent + // area + wxMask(const wxBitmap& bitmap, const wxColour& colour); -public: - wxBitmap(void); // Platform-specific + // Construct a mask from a bitmap and a palette index indicating the + // transparent area + wxMask(const wxBitmap& bitmap, int paletteIndex); - // 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 mono bitmap (copies the bitmap). + wxMask(const wxBitmap& bitmap); - // Initialize with raw data - wxBitmap(const char bits[], const int width, const int height, const int depth = 1); + // construct a mask from the givne bitmap handle + wxMask(WXHBITMAP hbmp) { m_maskBitmap = hbmp; } -#if USE_XPM_IN_MSW - class wxItem; - // Initialize with XPM data - wxBitmap(const char **data, wxItem *anItem = NULL); -#endif + 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, const long type = wxBITMAP_TYPE_BMP_RESOURCE); - - // New constructor for generalised creation from data - wxBitmap(void *data, const long type, const int width, const int height, const int depth = 1); - - // If depth is omitted, will create a bitmap compatible with the display - wxBitmap(const int width, const int height, const int depth = -1); - ~wxBitmap(void); - - virtual bool Create(const int width, const int height, const int depth = -1); - virtual bool Create(void *data, const long type, const int width, const int height, const int depth = 1); - virtual bool LoadFile(const wxString& name, const long type = wxBITMAP_TYPE_BMP_RESOURCE); - virtual bool SaveFile(const wxString& name, const 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); + DECLARE_DYNAMIC_CLASS(wxMask) +}; + +// ---------------------------------------------------------------------------- +// wxBitmapHandler is a class which knows how to load/save bitmaps to/from file +// ---------------------------------------------------------------------------- +class WXDLLEXPORT wxBitmapHandler : public wxGDIImageHandler +{ +public: + wxBitmapHandler() { m_type = wxBITMAP_TYPE_INVALID; } + 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, + 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); + + virtual bool Create(wxGDIImage *image, + void *data, + long flags, + int width, int height, int depth = 1); + virtual bool Load(wxGDIImage *image, + const wxString& name, + long flags, + int desiredWidth, int desiredHeight); + virtual bool Save(wxGDIImage *image, + const wxString& name, + int type); + +private: + DECLARE_DYNAMIC_CLASS(wxBitmapHandler) }; + #endif - // __BITMAPH__ + // _WX_BITMAP_H_