ignore VC8 project files and build directories

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

diff --git a/include/wx/msw/bitmap.h b/include/wx/msw/bitmap.h
index 536a62b307f945941c2468c430201a36e7803ed3..e0740f8832066a872a8071267f5fc010d7216b2b 100644 (file)
--- a/include/wx/msw/bitmap.h
+++ b/include/wx/msw/bitmap.h
@@ -12,26 +12,32 @@
 #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 wxBitmap;
-class WXDLLEXPORT wxBitmapHandler;
-class WXDLLEXPORT wxBitmapRefData;
-class WXDLLEXPORT wxControl;
-class WXDLLEXPORT wxCursor;
-class WXDLLEXPORT wxDC;
-class WXDLLEXPORT wxDIB;
-class WXDLLEXPORT wxIcon;
-class WXDLLEXPORT wxImage;
-class WXDLLEXPORT wxMask;
-class WXDLLEXPORT wxPalette;
-class WXDLLEXPORT wxRawBitmapData;
+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
+{
+  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
 
 // ----------------------------------------------------------------------------
 // wxBitmap: a mono or colour bitmap


@@ -41,23 +47,25 @@ 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);

 
     // Create a new, uninitialized bitmap of the given size and depth (if it
     // 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)


@@ -81,13 +89,10 @@ public:
 
     // 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)


@@ -114,17 +119,21 @@ public:
     wxBitmap GetSubBitmap( const wxRect& rect ) const;
 
     // copies the contents and mask of the given (colour) icon to the 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);
+    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);
     // 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, const wxDC& dc);
 
     virtual bool Create(int width, int height, int depth = -1);
     virtual bool Create(int width, int height, const wxDC& dc);

-    virtual bool Create(void *data, long type, int width, int height, int depth = 1);
+    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);
 


@@ -132,8 +141,8 @@ public:
         { return (wxBitmapRefData *)m_refData; }
 
     // raw bitmap access support functions
         { return (wxBitmapRefData *)m_refData; }
 
     // raw bitmap access support functions

-    bool GetRawData(wxRawBitmapData *data);
-    void UngetRawData(wxRawBitmapData *) { /* nothing to do here */ }
+    void *GetRawData(wxPixelDataBase& data, int bpp);
+    void UngetRawData(wxPixelDataBase& data);

 
 #if wxUSE_PALETTE
     wxPalette* GetPalette() const;
 
 #if wxUSE_PALETTE
     wxPalette* GetPalette() const;


@@ -141,31 +150,13 @@ public:
 #endif // wxUSE_PALETTE
 
     wxMask *GetMask() const;
 #endif // wxUSE_PALETTE
 
     wxMask *GetMask() const;

+    wxBitmap GetMaskBitmap() const;

     void SetMask(wxMask *mask);
 
     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; }
-
-    // this function is internal and shouldn't be used, it risks to disappear
+    // these functions are internal and shouldn't be used, they risk to
+    // disappear in the future

     bool HasAlpha() const;
     bool HasAlpha() const;

-
-#if WXWIN_COMPATIBILITY_2_4
-    // these functions do nothing and are only there for backwards
-    // compatibility
-    wxDEPRECATED( int GetQuality() const );
-    wxDEPRECATED( void SetQuality(int quality) );
-#endif // WXWIN_COMPATIBILITY_2_4
-
-#if WXWIN_COMPATIBILITY_2
-    void SetOk(bool isOk);
-#endif // WXWIN_COMPATIBILITY_2
-
-#if WXWIN_COMPATIBILITY
-#if wxUSE_PALETTE
-    wxPalette *GetColourMap() const { return GetPalette(); }
-    void SetColourMap(wxPalette *cmap) { SetPalette(*cmap); };
-#endif // wxUSE_PALETTE
-#endif // WXWIN_COMPATIBILITY
+    void UseAlpha();

 
     // implementation only from now on
     // -------------------------------
 
     // implementation only from now on
     // -------------------------------


@@ -180,13 +171,8 @@ public:
 #endif // __WXDEBUG__
 
 protected:
 #endif // __WXDEBUG__
 
 protected:

-    // common part of all ctors
-    void Init();
-

     virtual wxGDIImageRefData *CreateData() const;
     virtual wxGDIImageRefData *CreateData() const;

-
-    // creates the bitmap from XPM data, supposed to be called from ctor
-    bool CreateFromXpm(const char **bits);
+    virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;

 
     // creates an uninitialized bitmap, called from Create()s above
     bool DoCreate(int w, int h, int depth, WXHDC hdc);
 
     // creates an uninitialized bitmap, called from Create()s above
     bool DoCreate(int w, int h, int depth, WXHDC hdc);


@@ -203,10 +189,11 @@ protected:
 #endif // wxUSE_IMAGE
 
 private:
 #endif // wxUSE_IMAGE
 
 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)
 };


@@ -220,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);


@@ -257,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)
     {


@@ -266,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,


@@ -279,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,