X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/00e7a427a081f91b6a657d85c5ab6125fbea4d7c..0ecd03525b34edba886ca83ff724265cd912dbbd:/include/wx/msw/bitmap.h diff --git a/include/wx/msw/bitmap.h b/include/wx/msw/bitmap.h index f173d69e39..ef2a73fb27 100644 --- a/include/wx/msw/bitmap.h +++ b/include/wx/msw/bitmap.h @@ -12,110 +12,89 @@ #ifndef _WX_BITMAP_H_ #define _WX_BITMAP_H_ -#ifdef __GNUG__ - #pragma interface "bitmap.h" -#endif - #include "wx/msw/gdiimage.h" -#include "wx/gdicmn.h" #include "wx/palette.h" -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 -// ---------------------------------------------------------------------------- - -class WXDLLEXPORT wxBitmapRefData : public wxGDIImageRefData -{ -public: - wxBitmapRefData(); - virtual ~wxBitmapRefData() { Free(); } - - virtual void Free(); - -public: - 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; - -#if wxUSE_DIB_FOR_BITMAP - WXHANDLE m_hFileMap; // file mapping handle for large DIB's +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 - - - DECLARE_NO_COPY_CLASS(wxBitmapRefData) +class WXDLLIMPEXP_FWD_CORE wxIcon; +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 +// NOTE: for wxMSW we don't use the wxBitmapBase base class declared in bitmap.h! // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxBitmap : public wxGDIImage +class WXDLLIMPEXP_CORE wxBitmap : public wxGDIImage, + public wxBitmapHelpers { 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(const_cast(data)); + } +#endif // Load a file or resource - wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE); + wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE); // New constructor for generalised creation from data - wxBitmap(void *data, long type, int width, int height, int depth = 1); + wxBitmap(const void* data, wxBitmapType 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); + // 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) { (void)Create(width, height, depth); } + wxBitmap(const wxSize& sz, int depth = -1) { (void)Create(sz, depth); } + + // Create a bitmap compatible with the given DC + wxBitmap(int width, int height, const wxDC& dc); #if wxUSE_IMAGE - // Convert from wxImage: + // Convert from wxImage wxBitmap(const wxImage& image, int depth = -1) { (void)CreateFromImage(image, depth); } + + // Create a DDB compatible with the given DC from wxImage + wxBitmap(const wxImage& image, const wxDC& dc) + { (void)CreateFromImage(image, dc); } #endif // wxUSE_IMAGE // 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) @@ -136,101 +115,93 @@ public: #if wxUSE_IMAGE wxImage ConvertToImage() const; + wxBitmap ConvertToDisabled(unsigned char brightness = 255) 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); + 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 + bool CopyFromDIB(const wxDIB& dib); +#endif - 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); + virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH); + virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH) + { return Create(sz.GetWidth(), sz.GetHeight(), depth); } - wxBitmapRefData *GetBitmapData() const { return (wxBitmapRefData *)m_refData; } + 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; - int GetQuality() const { return (GetBitmapData() ? GetBitmapData()->m_quality : 0); } - void SetQuality(int q); + 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 { return (GetBitmapData() ? (& GetBitmapData()->m_bitmapPalette) : (wxPalette*) NULL); } + wxPalette* GetPalette() const; 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; } + wxMask *GetMask() const; + wxBitmap GetMaskBitmap() const; + void SetMask(wxMask *mask); -#if WXWIN_COMPATIBILITY_2 - void SetOk(bool isOk); -#endif // WXWIN_COMPATIBILITY_2 + // these functions are internal and shouldn't be used, they risk to + // disappear in the future + bool HasAlpha() const; + void UseAlpha(); -#if wxUSE_PALETTE -#if WXWIN_COMPATIBILITY - wxPalette *GetColourMap() const { return GetPalette(); } - void SetColourMap(wxPalette *cmap) { SetPalette(*cmap); }; -#endif // WXWIN_COMPATIBILITY -#endif // wxUSE_PALETTE + // implementation only from now on + // ------------------------------- - // Implementation public: void SetHBITMAP(WXHBITMAP bmp) { SetHandle((WXHANDLE)bmp); } WXHBITMAP GetHBITMAP() const { return (WXHBITMAP)GetHandle(); } -#if wxUSE_DIB_FOR_BITMAP - void SetHFileMap(WXHANDLE hFileMap) { GetBitmapData()->m_hFileMap = hFileMap; } - WXHANDLE GetHFileMap() const { return GetBitmapData()->m_hFileMap; } -#endif // wxUSE_DIB_FOR_BITMAP - - 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; + void SetSelectedInto(wxDC *dc); + wxDC *GetSelectedInto() const; protected: - // common part of all ctors - void Init(); - - virtual wxGDIImageRefData *CreateData() const - { return new wxBitmapRefData; } + virtual wxGDIImageRefData *CreateData() const; + virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const; - // creates the bitmap from XPM data, supposed to be called from ctor - bool CreateFromXpm(const char **bits); + // 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); -#endif // wxUSE_IMAGE -#if wxUSE_DIB_FOR_BITMAP - void *CreateDIB(int width, int height, int depth); - void CopyDIBLine(void* src, void* dest, int count) const; -#endif + // 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: -#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) }; @@ -239,11 +210,14 @@ private: // wxMask: a mono bitmap used for drawing bitmaps transparently. // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxMask : public wxObject +class WXDLLIMPEXP_CORE wxMask : public wxObject { 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); @@ -274,45 +248,49 @@ protected: 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 WXDLLEXPORT wxBitmapHandler : public wxGDIImageHandler +class WXDLLIMPEXP_CORE wxBitmapHandler : public wxGDIImageHandler { public: - wxBitmapHandler() { m_type = wxBITMAP_TYPE_INVALID; } - wxBitmapHandler(const wxString& name, const wxString& ext, long type) - : wxGDIImageHandler(name, ext, type) - { - } + wxBitmapHandler() { } + wxBitmapHandler(const wxString& name, const wxString& ext, wxBitmapType 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); + // implement wxGDIImageHandler's pure virtuals: virtual bool Create(wxGDIImage *image, - void *data, - long flags, + const void* data, + wxBitmapType type, int width, int height, int depth = 1); virtual bool Load(wxGDIImage *image, const wxString& name, - long flags, + wxBitmapType type, int desiredWidth, int desiredHeight); - virtual bool Save(wxGDIImage *image, + virtual bool Save(const wxGDIImage *image, const wxString& name, - int type); + 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)