add an assert indicating that old code overriding OnExecute() must be updated with 2.9

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

diff --git a/include/wx/bitmap.h b/include/wx/bitmap.h
index f0b8cb188364ac30f96190f0b9bff3e4797e712a..42f48524f95cbb316b9a01bd257986c3dec110da 100644 (file)
--- a/include/wx/bitmap.h
+++ b/include/wx/bitmap.h
@@ -20,12 +20,12 @@
 #include "wx/gdicmn.h"  // for wxBitmapType
 #include "wx/colour.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;
+class WXDLLIMPEXP_FWD_CORE wxBitmap;
+class WXDLLIMPEXP_FWD_CORE wxBitmapHandler;
+class WXDLLIMPEXP_FWD_CORE wxIcon;
+class WXDLLIMPEXP_FWD_CORE wxImage;
+class WXDLLIMPEXP_FWD_CORE wxMask;
+class WXDLLIMPEXP_FWD_CORE wxPalette;

 
 // ----------------------------------------------------------------------------
 // wxVariant support
 
 // ----------------------------------------------------------------------------
 // wxVariant support


@@ -33,14 +33,16 @@ class WXDLLEXPORT wxPalette;
 
 #if wxUSE_VARIANT
 #include "wx/variant.h"
 
 #if wxUSE_VARIANT
 #include "wx/variant.h"

-DECLARE_VARIANT_OBJECT_EXPORTED(wxBitmap,WXDLLEXPORT)
+DECLARE_VARIANT_OBJECT_EXPORTED(wxBitmap,WXDLLIMPEXP_CORE)

 #endif
 
 // ----------------------------------------------------------------------------
 // wxMask represents the transparent area of the bitmap
 // ----------------------------------------------------------------------------
 
 #endif
 
 // ----------------------------------------------------------------------------
 // wxMask represents the transparent area of the bitmap
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxMaskBase : public wxObject
+// TODO: all implementation of wxMask, except the generic one,
+//       do not derive from wxMaskBase,,, they should
+class WXDLLIMPEXP_CORE wxMaskBase : public wxObject

 {
 public:
     // create the mask from bitmap pixels of the given colour
 {
 public:
     // create the mask from bitmap pixels of the given colour


@@ -78,8 +80,13 @@ protected:
     #define wxUSE_BITMAP_BASE 0
 #endif
 
     #define wxUSE_BITMAP_BASE 0
 #endif
 

-// Only used by some ports
-// FIXME -- make all ports (but MSW which uses wxGDIImage) use these base classes
+// a more readable way to tell
+#define wxBITMAP_SCREEN_DEPTH       (-1)
+
+
+// All ports except wxMSW,wxOS2,wxPalmOS use wxBitmapHandler and wxBitmapBase as base class
+// for wxBitmapHandler; wxMSW,wxOS2,wxPalmOS use wxGDIImageHandler as base class
+// since it allows some code reuse there.

 #if wxUSE_BITMAP_BASE
 
 // ----------------------------------------------------------------------------
 #if wxUSE_BITMAP_BASE
 
 // ----------------------------------------------------------------------------


@@ -87,18 +94,29 @@ protected:
 // different formats
 // ----------------------------------------------------------------------------
 
 // different formats
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxBitmapHandlerBase : public wxObject
+class WXDLLIMPEXP_CORE wxBitmapHandler : public wxObject

 {
 public:
 {
 public:

-    wxBitmapHandlerBase() { m_type = wxBITMAP_TYPE_INVALID; }
-    virtual ~wxBitmapHandlerBase() { }
+    wxBitmapHandler() { m_type = wxBITMAP_TYPE_INVALID; }
+    virtual ~wxBitmapHandler() { }
+
+    // NOTE: the following functions should be pure virtuals, but they aren't
+    //       because otherwise almost all ports would have to implement
+    //       them as "return false"...
+
+    virtual bool Create(wxBitmap *WXUNUSED(bitmap), const void* WXUNUSED(data),
+                         wxBitmapType WXUNUSED(type), int WXUNUSED(width), int WXUNUSED(height),
+                         int WXUNUSED(depth) = 1)
+        { return false; }
+
+    virtual bool LoadFile(wxBitmap *WXUNUSED(bitmap), const wxString& WXUNUSED(name),
+                           wxBitmapType WXUNUSED(type), int WXUNUSED(desiredWidth),
+                           int WXUNUSED(desiredHeight))
+        { return false; }

 
 

-    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(const wxBitmap *bitmap, const wxString& name,
-                          int type, const wxPalette *palette = NULL);
+    virtual bool SaveFile(const wxBitmap *WXUNUSED(bitmap), const wxString& WXUNUSED(name),
+                           wxBitmapType WXUNUSED(type), const wxPalette *WXUNUSED(palette) = NULL) const
+        { return false; }

 
     void SetName(const wxString& name)      { m_name = name; }
     void SetExtension(const wxString& ext)  { m_extension = ext; }
 
     void SetName(const wxString& name)      { m_name = name; }
     void SetExtension(const wxString& ext)  { m_extension = ext; }


@@ -112,36 +130,40 @@ private:
     wxString      m_extension;
     wxBitmapType  m_type;
 
     wxString      m_extension;
     wxBitmapType  m_type;
 

-    DECLARE_ABSTRACT_CLASS(wxBitmapHandlerBase)
+    DECLARE_ABSTRACT_CLASS(wxBitmapHandler)

 };
 
 };
 

-class WXDLLEXPORT wxBitmapBase : public wxGDIObject
+
+// ----------------------------------------------------------------------------
+// wxBitmap: class which represents platform-dependent bitmap (unlike wxImage)
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxBitmapBase : public wxGDIObject

 {
 public:
     /*
     Derived class must implement these:
 
     wxBitmap();
 {
 public:
     /*
     Derived class must implement these:
 
     wxBitmap();

-    wxBitmap(int width, int height, int depth = -1);
+    wxBitmap(const wxBitmap& bmp);

     wxBitmap(const char bits[], int width, int height, int depth = 1);
     wxBitmap(const char bits[], int width, int height, int depth = 1);

+    wxBitmap(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);

     wxBitmap(const char* const* bits);
     wxBitmap(const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM);
     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);
+    wxBitmap(const wxImage& image, int depth = wxBITMAP_SCREEN_DEPTH);

 
     static void InitStandardHandlers();
     */
 
 
     static void InitStandardHandlers();
     */
 

-    virtual bool Ok() const = 0;
+    virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH) = 0;

 
     virtual int GetHeight() const = 0;
     virtual int GetWidth() const = 0;
     virtual int GetDepth() const = 0;
 
 
     virtual int GetHeight() const = 0;
     virtual int GetWidth() const = 0;
     virtual int GetDepth() const = 0;
 

+#if wxUSE_IMAGE

     virtual wxImage ConvertToImage() const = 0;
     virtual wxImage ConvertToImage() const = 0;

+#endif // wxUSE_IMAGE

 
     virtual wxMask *GetMask() const = 0;
     virtual void SetMask(wxMask *mask) = 0;
 
     virtual wxMask *GetMask() const = 0;
     virtual void SetMask(wxMask *mask) = 0;


@@ -175,8 +197,8 @@ public:
 
     // Format handling
     static inline wxList& GetHandlers() { return sm_handlers; }
 
     // Format handling
     static inline wxList& GetHandlers() { return sm_handlers; }

-    static void AddHandler(wxBitmapHandlerBase *handler);
-    static void InsertHandler(wxBitmapHandlerBase *handler);
+    static void AddHandler(wxBitmapHandler *handler);
+    static void InsertHandler(wxBitmapHandler *handler);

     static bool RemoveHandler(const wxString& name);
     static wxBitmapHandler *FindHandler(const wxString& name);
     static wxBitmapHandler *FindHandler(const wxString& extension, wxBitmapType bitmapType);
     static bool RemoveHandler(const wxString& name);
     static wxBitmapHandler *FindHandler(const wxString& name);
     static wxBitmapHandler *FindHandler(const wxString& extension, wxBitmapType bitmapType);