fix unused parameters warnings

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

diff --git a/include/wx/bitmap.h b/include/wx/bitmap.h
index a4c5d1b1d49a9c012e95d2569d3066f6337b33f1..4153de3a39148e61507face9147f2ba151a89c49 100644 (file)
--- a/include/wx/bitmap.h
+++ b/include/wx/bitmap.h
@@ -16,18 +16,56 @@
 // headers
 // ----------------------------------------------------------------------------
 
-#include "wx/defs.h"
-#include "wx/object.h"
 #include "wx/string.h"
-#include "wx/gdiobj.h"
 #include "wx/gdicmn.h"  // for wxBitmapType
+#include "wx/colour.h"
 
 class WXDLLEXPORT wxBitmap;
 class WXDLLEXPORT wxBitmapHandler;
+class WXDLLEXPORT wxIcon;
 class WXDLLEXPORT wxImage;
 class WXDLLEXPORT wxMask;
 class WXDLLEXPORT wxPalette;
 
+// ----------------------------------------------------------------------------
+// wxVariant support
+// ----------------------------------------------------------------------------
+
+#if wxUSE_VARIANT
+#include "wx/variant.h"
+DECLARE_VARIANT_OBJECT_EXPORTED(wxBitmap,WXDLLEXPORT)
+#endif
+
+// ----------------------------------------------------------------------------
+// wxMask represents the transparent area of the bitmap
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxMaskBase : public wxObject
+{
+public:
+    // create the mask from bitmap pixels of the given colour
+    bool Create(const wxBitmap& bitmap, const wxColour& colour);
+
+#if wxUSE_PALETTE
+    // create the mask from bitmap pixels with the given palette index
+    bool Create(const wxBitmap& bitmap, int paletteIndex);
+#endif // wxUSE_PALETTE
+
+    // create the mask from the given mono bitmap
+    bool Create(const wxBitmap& bitmap);
+
+protected:
+    // this function is called from Create() to free the existing mask data
+    virtual void FreeData() = 0;
+
+    // these functions must be overridden to implement the corresponding public
+    // Create() methods, they shouldn't call FreeData() as it's already called
+    // by the public wrappers
+    virtual bool InitFromColour(const wxBitmap& bitmap,
+                                const wxColour& colour) = 0;
+    virtual bool InitFromMonoBitmap(const wxBitmap& bitmap) = 0;
+};
+
 #if defined(__WXMGL__) || \
     defined(__WXDFB__) || \
     defined(__WXMAC__) || \
@@ -52,26 +90,21 @@ class WXDLLEXPORT wxPalette;
 class WXDLLEXPORT wxBitmapHandlerBase : public wxObject
 {
 public:
-    wxBitmapHandlerBase()
-        : m_name()
-        , m_extension()
-        , m_type(wxBITMAP_TYPE_INVALID)
-    { }
-
+    wxBitmapHandlerBase() { m_type = wxBITMAP_TYPE_INVALID; }
     virtual ~wxBitmapHandlerBase() { }
 
-    virtual bool Create(wxBitmap *bitmap, void *data, long flags,
-                          int width, int height, int depth = 1) = 0;
+    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) = 0;
+                          int desiredWidth, int desiredHeight);
     virtual bool SaveFile(const wxBitmap *bitmap, const wxString& name,
-                          int type, const wxPalette *palette = NULL) = 0;
+                          int type, const wxPalette *palette = NULL);
 
     void SetName(const wxString& name)      { m_name = name; }
     void SetExtension(const wxString& ext)  { m_extension = ext; }
     void SetType(wxBitmapType type)         { m_type = type; }
-    wxString GetName() const                { return m_name; }
-    wxString GetExtension() const           { return m_extension; }
+    const wxString& GetName() const         { return m_name; }
+    const wxString& GetExtension() const    { return m_extension; }
     wxBitmapType GetType() const            { return m_type; }
 
 private:
@@ -79,7 +112,6 @@ private:
     wxString      m_extension;
     wxBitmapType  m_type;
 
-private:
     DECLARE_ABSTRACT_CLASS(wxBitmapHandlerBase)
 };
 
@@ -92,19 +124,17 @@ public:
     wxBitmap();
     wxBitmap(int width, int height, int depth = -1);
     wxBitmap(const char bits[], int width, int height, int depth = 1);
-    wxBitmap(const char **bits);
-    wxBitmap(char **bits);
+    wxBitmap(const char* const* bits);
     wxBitmap(const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM);
     wxBitmap(const wxImage& image, int depth = -1);
-    bool operator == (const wxBitmap& bmp) const;
-    bool operator != (const wxBitmap& bmp) const;
 
     bool Create(int width, int height, int depth = -1);
 
     static void InitStandardHandlers();
     */
 
-    virtual bool Ok() const = 0;
+    virtual bool Ok() const { return IsOk(); }
+    virtual bool IsOk() const = 0;
 
     virtual int GetHeight() const = 0;
     virtual int GetWidth() const = 0;
@@ -156,6 +186,15 @@ public:
 
     static void CleanUpHandlers();
 
+    // this method is only used by the generic implementation of wxMask
+    // currently but could be useful elsewhere in the future: it can be
+    // overridden to quantize the colour to correspond to bitmap colour depth
+    // if necessary; default implementation simply returns the colour as is
+    virtual wxColour QuantizeColour(const wxColour& colour) const
+    {
+        return colour;
+    }
+
 protected:
     static wxList sm_handlers;
 
@@ -188,4 +227,15 @@ protected:
     #include "wx/os2/bitmap.h"
 #endif
 
+// we must include generic mask.h after wxBitmap definition
+#if defined(__WXMGL__) || defined(__WXDFB__)
+    #define wxUSE_GENERIC_MASK 1
+#else
+    #define wxUSE_GENERIC_MASK 0
+#endif
+
+#if wxUSE_GENERIC_MASK
+    #include "wx/generic/mask.h"
+#endif
+
 #endif // _WX_BITMAP_H_BASE_