X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b5dbe15d0bacde245539f54c4d97af6b4696f01f..ab06470e494cac713cbf6d238ff1c4fd2850ea7e:/include/wx/msw/bitmap.h?ds=sidebyside diff --git a/include/wx/msw/bitmap.h b/include/wx/msw/bitmap.h index ffde65f429..205370f459 100644 --- a/include/wx/msw/bitmap.h +++ b/include/wx/msw/bitmap.h @@ -30,11 +30,21 @@ 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: // default ctor creates an invalid bitmap, you must Create() it later @@ -48,22 +58,23 @@ public: #ifdef wxNEEDS_CHARPP wxBitmap(char** data) { - *this = wxBitmap(wx_const_cast(const char* const*, 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(const void* data, long type, int width, int height, int depth = 1); + wxBitmap(const void* data, wxBitmapType 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) // // 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); + 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); @@ -80,7 +91,11 @@ public: // 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) { CopyFromIcon(icon); } + wxBitmap(const wxIcon& icon, + wxBitmapTransparency transp = wxBitmapTransparency_Auto) + { + CopyFromIcon(icon, transp); + } wxBitmap& operator=(const wxIcon& icon) { @@ -105,22 +120,31 @@ public: // 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(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); } + virtual bool Create(int width, int height, const wxDC& dc); - 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); + 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; wxBitmapRefData *GetBitmapData() const { return (wxBitmapRefData *)m_refData; } @@ -150,14 +174,12 @@ public: void SetHBITMAP(WXHBITMAP bmp) { SetHandle((WXHANDLE)bmp); } WXHBITMAP GetHBITMAP() const { return (WXHBITMAP)GetHandle(); } -#ifdef __WXDEBUG__ void SetSelectedInto(wxDC *dc); wxDC *GetSelectedInto() const; -#endif // __WXDEBUG__ protected: virtual wxGDIImageRefData *CreateData() const; - virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const; + virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const; // creates an uninitialized bitmap, called from Create()s above bool DoCreate(int w, int h, int depth, WXHDC hdc); @@ -175,7 +197,9 @@ protected: private: // common part of CopyFromIcon/CopyFromCursor for Win32 - bool CopyFromIconOrCursor(const wxGDIImage& icon); + bool + CopyFromIconOrCursor(const wxGDIImage& icon, + wxBitmapTransparency transp = wxBitmapTransparency_Auto); DECLARE_DYNAMIC_CLASS(wxBitmap) @@ -185,7 +209,7 @@ private: // wxMask: a mono bitmap used for drawing bitmaps transparently. // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxMask : public wxObject +class WXDLLIMPEXP_CORE wxMask : public wxObject { public: wxMask(); @@ -223,45 +247,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() { } - wxBitmapHandler(const wxString& name, const wxString& ext, long type) - : wxGDIImageHandler(name, ext, type) - { - } + 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, - const 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, const void* data, - long flags, + 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)