removed unused wxUSE_XXX options (patch 1759328)

[wxWidgets.git] / include / wx / msw / bitmap.h

diff --git a/include/wx/msw/bitmap.h b/include/wx/msw/bitmap.h
index 2aab4a41eee87034f901908b53899a10cb6ca5eb..e0740f8832066a872a8071267f5fc010d7216b2b 100644 (file)
--- a/include/wx/msw/bitmap.h
+++ b/include/wx/msw/bitmap.h
@@ -12,54 +12,31 @@
 #ifndef _WX_BITMAP_H_
 #define _WX_BITMAP_H_
 
 #ifndef _WX_BITMAP_H_
 #define _WX_BITMAP_H_
 

-#ifdef __GNUG__
-    #pragma interface "bitmap.h"
-#endif
-

 #include "wx/msw/gdiimage.h"
 #include "wx/msw/gdiimage.h"

-#include "wx/gdicmn.h"

 #include "wx/palette.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;
-
-// ----------------------------------------------------------------------------
-// Bitmap data
-//
-// NB: this class is private, but declared here to make it possible inline
-//     wxBitmap functions accessing it
-// ----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxBitmapRefData : public wxGDIImageRefData
+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
+class WXDLLIMPEXP_FWD_CORE wxIcon;
+class WXDLLIMPEXP_FWD_CORE wxImage;
+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

 {
 {

-public:
-    wxBitmapRefData();
-    virtual ~wxBitmapRefData() { Free(); }
-
-    virtual void Free();
-
-public:
-    int           m_numColors;
-    wxPalette     m_bitmapPalette;
-    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;
+  wxBitmapTransparency_Auto,    // default: copy alpha if the source has it
+  wxBitmapTransparency_None,    // never create alpha
+  wxBitmapTransparency_Always   // always use alpha

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -70,39 +47,52 @@ class WXDLLEXPORT wxBitmap : public wxGDIImage
 {
 public:
     // default ctor creates an invalid bitmap, you must Create() it later
 {
 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
 
     // 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(wx_const_cast(const char* const*, data));
+    }
+#endif

 
     // Load a file or resource
     wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
 
     // New constructor for generalised creation from data
 
     // Load a file or resource
     wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
 
     // New constructor for generalised creation from data

-    wxBitmap(void *data, long type, int width, int height, int depth = 1);
+    wxBitmap(const void* data, long type, int width, int height, int depth = 1);

 
 

-    // If depth is omitted, will create a bitmap compatible with the display
+    // 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);

-    
-    // Convert from wxImage:
-    wxBitmap(const wxImage& image, int depth = -1) { (void)CreateFromImage(image, depth); }   
+
+    // Create a bitmap compatible with the given DC
+    wxBitmap(int width, int height, const wxDC& dc);
+
+#if wxUSE_IMAGE
+    // 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!
 
     // 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)
     }
 
     wxBitmap& operator=(const wxIcon& icon)


@@ -121,85 +111,89 @@ public:
 
     virtual ~wxBitmap();
 
 
     virtual ~wxBitmap();
 

+#if wxUSE_IMAGE

     wxImage ConvertToImage() const;
     wxImage ConvertToImage() const;

+#endif // wxUSE_IMAGE

 
     // get the given part of bitmap
     wxBitmap GetSubBitmap( const wxRect& rect ) const;
 
     // 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
     // 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
 
     // 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 = -1);

-    virtual bool Create(void *data, long type, int width, int height, int depth = 1);
+    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 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; }
+    wxBitmapRefData *GetBitmapData() const
+        { return (wxBitmapRefData *)m_refData; }

 
 

-    int GetQuality() const { return (GetBitmapData() ? GetBitmapData()->m_quality : 0); }
-    void SetQuality(int q);
+    // raw bitmap access support functions
+    void *GetRawData(wxPixelDataBase& data, int bpp);
+    void UngetRawData(wxPixelDataBase& data);

 
 

-    wxPalette* GetPalette() const { return (GetBitmapData() ? (& GetBitmapData()->m_bitmapPalette) : (wxPalette*) NULL); }
+#if wxUSE_PALETTE
+    wxPalette* GetPalette() const;

     void SetPalette(const wxPalette& palette);
     void SetPalette(const wxPalette& palette);

+#endif // wxUSE_PALETTE

 
 

-    wxMask *GetMask() const { return (GetBitmapData() ? GetBitmapData()->m_bitmapMask : (wxMask*) NULL); }
-    void SetMask(wxMask *mask) ;
+    wxMask *GetMask() const;
+    wxBitmap GetMaskBitmap() const;
+    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; }
+    // these functions are internal and shouldn't be used, they risk to
+    // disappear in the future
+    bool HasAlpha() const;
+    void UseAlpha();

 
 

-#if WXWIN_COMPATIBILITY_2
-    void SetOk(bool isOk);
-#endif // WXWIN_COMPATIBILITY_2
+    // implementation only from now on
+    // -------------------------------

 
 

-#if WXWIN_COMPATIBILITY
-    wxPalette *GetColourMap() const { return GetPalette(); }
-    void SetColourMap(wxPalette *cmap) { SetPalette(*cmap); };
-#endif // WXWIN_COMPATIBILITY
-
-    // Implementation

 public:
     void SetHBITMAP(WXHBITMAP bmp) { SetHandle((WXHANDLE)bmp); }
     WXHBITMAP GetHBITMAP() const { return (WXHBITMAP)GetHandle(); }
 
 public:
     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
-    // <frederic.villeneuve@natinst.com>
-    wxBitmap GetBitmapForDC(wxDC& dc) const;
+#ifdef __WXDEBUG__
+    void SetSelectedInto(wxDC *dc);
+    wxDC *GetSelectedInto() const;
+#endif // __WXDEBUG__

 
 protected:
 
 protected:

-    // common part of all ctors
-    void Init();
+    virtual wxGDIImageRefData *CreateData() const;
+    virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;

 
 

-    virtual wxGDIImageRefData *CreateData() const
-        { return new wxBitmapRefData; }
+    // creates an uninitialized bitmap, called from Create()s above
+    bool DoCreate(int w, int h, int depth, WXHDC hdc);

 
 

-    // 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);
 
     // creates the bitmap from wxImage, supposed to be called from ctor
     bool CreateFromImage(const wxImage& image, int depth);
 

+    // 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:
 
 private:

-#ifdef __WIN32__

     // common part of CopyFromIcon/CopyFromCursor for 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)
 };
 
     DECLARE_DYNAMIC_CLASS(wxBitmap)
 };


@@ -213,6 +207,9 @@ class WXDLLEXPORT wxMask : public wxObject
 public:
     wxMask();
 
 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);
     // Construct a mask from a bitmap and a colour indicating the transparent
     // area
     wxMask(const wxBitmap& bitmap, const wxColour& colour);


@@ -250,7 +247,7 @@ protected:
 class WXDLLEXPORT wxBitmapHandler : public wxGDIImageHandler
 {
 public:
 class WXDLLEXPORT wxBitmapHandler : public wxGDIImageHandler
 {
 public:

-    wxBitmapHandler() { m_type = wxBITMAP_TYPE_INVALID; }
+    wxBitmapHandler() { }

     wxBitmapHandler(const wxString& name, const wxString& ext, long type)
         : wxGDIImageHandler(name, ext, type)
     {
     wxBitmapHandler(const wxString& name, const wxString& ext, long type)
         : wxGDIImageHandler(name, ext, type)
     {


@@ -259,7 +256,7 @@ public:
     // keep wxBitmapHandler derived from wxGDIImageHandler compatible with the
     // old class which worked only with bitmaps
     virtual bool Create(wxBitmap *bitmap,
     // keep wxBitmapHandler derived from wxGDIImageHandler compatible with the
     // old class which worked only with bitmaps
     virtual bool Create(wxBitmap *bitmap,

-                        void *data,
+                        const void* data,

                         long flags,
                         int width, int height, int depth = 1);
     virtual bool LoadFile(wxBitmap *bitmap,
                         long flags,
                         int width, int height, int depth = 1);
     virtual bool LoadFile(wxBitmap *bitmap,


@@ -272,7 +269,7 @@ public:
                           const wxPalette *palette = NULL);
 
     virtual bool Create(wxGDIImage *image,
                           const wxPalette *palette = NULL);
 
     virtual bool Create(wxGDIImage *image,

-                        void *data,
+                        const void* data,

                         long flags,
                         int width, int height, int depth = 1);
     virtual bool Load(wxGDIImage *image,
                         long flags,
                         int width, int height, int depth = 1);
     virtual bool Load(wxGDIImage *image,