Don't define __STRICT_ANSI__, we should build both with and without it.

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

diff --git a/include/wx/bitmap.h b/include/wx/bitmap.h
index 4153de3a39148e61507face9147f2ba151a89c49..6d9ffe71b75192a32cc34862c5e70c6d440dc3e7 100644 (file)
--- a/include/wx/bitmap.h
+++ b/include/wx/bitmap.h
@@ -4,7 +4,6 @@
 // Author:      Vaclav Slavik
 // Modified by:
 // Created:     22.04.01
 // Author:      Vaclav Slavik
 // Modified by:
 // Created:     22.04.01

-// RCS-ID:      $Id$

 // Copyright:   (c) wxWidgets team
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) wxWidgets team
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////


@@ -19,13 +18,14 @@
 #include "wx/string.h"
 #include "wx/gdicmn.h"  // for wxBitmapType
 #include "wx/colour.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"  // for wxBitmapType
 #include "wx/colour.h"

+#include "wx/image.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 wxMask;
+class WXDLLIMPEXP_FWD_CORE wxPalette;
+class WXDLLIMPEXP_FWD_CORE wxDC;

 
 // ----------------------------------------------------------------------------
 // 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


@@ -66,8 +68,7 @@ protected:
     virtual bool InitFromMonoBitmap(const wxBitmap& bitmap) = 0;
 };
 
     virtual bool InitFromMonoBitmap(const wxBitmap& bitmap) = 0;
 };
 

-#if defined(__WXMGL__) || \
-    defined(__WXDFB__) || \
+#if defined(__WXDFB__) || \

     defined(__WXMAC__) || \
     defined(__WXGTK__) || \
     defined(__WXCOCOA__) || \
     defined(__WXMAC__) || \
     defined(__WXGTK__) || \
     defined(__WXCOCOA__) || \


@@ -78,8 +79,30 @@ 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)
+
+
+// ----------------------------------------------------------------------------
+// wxBitmapHelpers: container for various bitmap methods common to all ports.
+// ----------------------------------------------------------------------------
+
+// Unfortunately, currently wxBitmap does not inherit from wxBitmapBase on all
+// platforms and this is not easy to fix. So we extract at least some common
+// methods into this class from which both wxBitmapBase (and hence wxBitmap on
+// all platforms where it does inherit from it) and wxBitmap in wxMSW and other
+// exceptional ports (only wxPM and old wxCocoa) inherit.
+class WXDLLIMPEXP_CORE wxBitmapHelpers
+{
+public:
+    // Create a new wxBitmap from the PNG data in the given buffer.
+    static wxBitmap NewFromPNGData(const void* data, size_t size);
+};
+
+
+// All ports except wxMSW and wxOS2 use wxBitmapHandler and wxBitmapBase as
+// base class for wxBitmapHandler; wxMSW and wxOS2 use wxGDIImageHandler as
+// base class since it allows some code reuse there.

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


@@ -87,18 +110,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,43 +146,65 @@ 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 wxBitmapHelpers

 {
 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 wxSize& sz, 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 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 { return IsOk(); }
-    virtual bool IsOk() const = 0;
+    virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH) = 0;
+    virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH) = 0;
+    virtual bool CreateScaled(int w, int h, int d, double logicalScale)
+        { return Create(w*logicalScale,h*logicalScale,d); }

 
     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;
 

+    wxSize GetSize() const
+        { return wxSize(GetWidth(), GetHeight()); }
+
+    // support for scaled bitmaps
+    virtual double GetScaleFactor() const { return 1.0; }
+    virtual double GetScaledWidth() const { return GetWidth() / GetScaleFactor(); }
+    virtual double GetScaledHeight() const { return GetHeight() / GetScaleFactor(); }
+    virtual wxSize GetScaledSize() const
+    { return wxSize(GetScaledWidth(), GetScaledHeight()); }
+
+#if wxUSE_IMAGE

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

+    // Convert to disabled (dimmed) bitmap.
+    wxBitmap ConvertToDisabled(unsigned char brightness = 255) const;
+#endif // wxUSE_IMAGE
+

     virtual wxMask *GetMask() const = 0;
     virtual void SetMask(wxMask *mask) = 0;
 
     virtual wxBitmap GetSubBitmap(const wxRect& rect) const = 0;
 
     virtual bool SaveFile(const wxString &name, wxBitmapType type,
     virtual wxMask *GetMask() const = 0;
     virtual void SetMask(wxMask *mask) = 0;
 
     virtual wxBitmap GetSubBitmap(const wxRect& rect) const = 0;
 
     virtual bool SaveFile(const wxString &name, wxBitmapType type,

-                          const wxPalette *palette = (wxPalette *)NULL) const = 0;
+                          const wxPalette *palette = NULL) const = 0;

     virtual bool LoadFile(const wxString &name, wxBitmapType type) = 0;
 
     /*
     virtual bool LoadFile(const wxString &name, wxBitmapType type) = 0;
 
     /*


@@ -174,8 +230,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);


@@ -203,32 +259,58 @@ protected:
 
 #endif // wxUSE_BITMAP_BASE
 
 
 #endif // wxUSE_BITMAP_BASE
 

-#if defined(__WXPALMOS__)
-    #include "wx/palmos/bitmap.h"
-#elif defined(__WXMSW__)
+
+// the wxBITMAP_DEFAULT_TYPE constant defines the default argument value
+// for wxBitmap's ctor and wxBitmap::LoadFile() functions.
+#if defined(__WXMSW__)
+    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_BMP_RESOURCE

     #include "wx/msw/bitmap.h"
 #elif defined(__WXMOTIF__)
     #include "wx/msw/bitmap.h"
 #elif defined(__WXMOTIF__)

+    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_XPM

     #include "wx/x11/bitmap.h"
 #elif defined(__WXGTK20__)
     #include "wx/x11/bitmap.h"
 #elif defined(__WXGTK20__)

+    #ifdef __WINDOWS__
+        #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_BMP_RESOURCE
+    #else
+        #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_XPM
+    #endif

     #include "wx/gtk/bitmap.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/bitmap.h"
 #elif defined(__WXGTK__)

+    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_XPM

     #include "wx/gtk1/bitmap.h"
 #elif defined(__WXX11__)
     #include "wx/gtk1/bitmap.h"
 #elif defined(__WXX11__)

+    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_XPM

     #include "wx/x11/bitmap.h"
     #include "wx/x11/bitmap.h"

-#elif defined(__WXMGL__)
-    #include "wx/mgl/bitmap.h"

 #elif defined(__WXDFB__)
 #elif defined(__WXDFB__)

+    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_BMP_RESOURCE

     #include "wx/dfb/bitmap.h"
 #elif defined(__WXMAC__)
     #include "wx/dfb/bitmap.h"
 #elif defined(__WXMAC__)

-    #include "wx/mac/bitmap.h"
+    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_PICT_RESOURCE
+    #include "wx/osx/bitmap.h"

 #elif defined(__WXCOCOA__)
 #elif defined(__WXCOCOA__)

+    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_BMP_RESOURCE

     #include "wx/cocoa/bitmap.h"
 #elif defined(__WXPM__)
     #include "wx/cocoa/bitmap.h"
 #elif defined(__WXPM__)

+    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_BMP_RESOURCE

     #include "wx/os2/bitmap.h"
 #endif
 
     #include "wx/os2/bitmap.h"
 #endif
 

+#if wxUSE_IMAGE
+inline
+wxBitmap
+#if wxUSE_BITMAP_BASE
+wxBitmapBase::
+#else
+wxBitmap::
+#endif
+ConvertToDisabled(unsigned char brightness) const
+{
+    return ConvertToImage().ConvertToDisabled(brightness);
+}
+#endif // wxUSE_IMAGE
+

 // we must include generic mask.h after wxBitmap definition
 // we must include generic mask.h after wxBitmap definition

-#if defined(__WXMGL__) || defined(__WXDFB__)
+#if defined(__WXDFB__)

     #define wxUSE_GENERIC_MASK 1
 #else
     #define wxUSE_GENERIC_MASK 0
     #define wxUSE_GENERIC_MASK 1
 #else
     #define wxUSE_GENERIC_MASK 0