Add wxCursor ctor from XPM data to all ports

This just uses the existing wxImage ctor from XPM data and wxCursor ctor
from wxImage, but will allow the code creating cursors from XPM to still
work even when wxImage ctor from XPM is made explicit.

Add a trivial test just to check that the new ctor can be used.

include/wx/dfb/cursor.h

@@ -11,6 +11,7 @@
 #define _WX_DFB_CURSOR_H_
 
 class WXDLLIMPEXP_FWD_CORE wxBitmap;
+class WXDLLIMPEXP_FWD_CORE wxImage;
 
 //-----------------------------------------------------------------------------
 // wxCursor
@@ -24,6 +25,10 @@ public:
 #if WXWIN_COMPATIBILITY_2_8
     wxCursor(int id) { InitFromStock((wxStockCursor)id); }
 #endif
+#if wxUSE_IMAGE
+    wxCursor(const wxImage& image);
+    wxCursor(const char* const* xpmData);
+#endif // wxUSE_IMAGE
     wxCursor(const wxString& name,
              wxBitmapType type = wxCURSOR_DEFAULT_TYPE,
              int hotSpotX = 0, int hotSpotY = 0);

include/wx/gtk/cursor.h

@@ -25,6 +25,7 @@ public:
 #endif
 #if wxUSE_IMAGE
     wxCursor( const wxImage & image );
+    wxCursor(const char* const* xpmData);
 #endif // wxUSE_IMAGE
     wxCursor(const wxString& name,
              wxBitmapType type = wxCURSOR_DEFAULT_TYPE,

include/wx/motif/cursor.h

@@ -32,6 +32,7 @@ public:
 
 #if wxUSE_IMAGE
     wxCursor(const wxImage& image);
+    wxCursor(const char* const* xpmData);
 #endif
 
     wxCursor(wxStockCursor id) { InitFromStock(id); }
@@ -52,6 +53,10 @@ protected:
 private:
     void InitFromStock(wxStockCursor);
 
+#if wxUSE_IMAGE
+    void InitFromImage(const wxImage& image);
+#endif
+
     void Create(const char bits[], int width, int height,
                 int hotSpotX = -1, int hotSpotY = -1,
                 const char maskBits[] = NULL);

include/wx/msw/cursor.h

@@ -21,6 +21,7 @@ public:
     wxCursor();
 #if wxUSE_IMAGE
     wxCursor(const wxImage& image);
+    wxCursor(const char* const* xpmData);
 #endif // wxUSE_IMAGE
     wxCursor(const wxString& name,
              wxBitmapType type = wxCURSOR_DEFAULT_TYPE,
@@ -44,6 +45,10 @@ protected:
     virtual wxGDIImageRefData *CreateData() const wxOVERRIDE;
 
 private:
+#if wxUSE_IMAGE
+    void InitFromImage(const wxImage& image);
+#endif // wxUSE_IMAGE
+
     wxDECLARE_DYNAMIC_CLASS(wxCursor);
 };
 

include/wx/osx/cursor.h

@@ -21,6 +21,7 @@ public:
 
 #if wxUSE_IMAGE
     wxCursor(const wxImage & image) ;
+    wxCursor(const char* const* xpmData);
 #endif // wxUSE_IMAGE
     wxCursor(const wxString& name,
              wxBitmapType type = wxCURSOR_DEFAULT_TYPE,

include/wx/qt/cursor.h

@@ -22,6 +22,7 @@ public:
 #endif
 #if wxUSE_IMAGE
     wxCursor( const wxImage & image );
+    wxCursor(const char* const* xpmData);
 #endif // wxUSE_IMAGE
     wxCursor(const wxString& name,
              wxBitmapType type = wxCURSOR_DEFAULT_TYPE,

include/wx/x11/cursor.h

@@ -29,6 +29,7 @@ public:
 #endif
 #if wxUSE_IMAGE
     wxCursor( const wxImage & image );
+    wxCursor(const char* const* xpmData);
 #endif
 
     wxCursor(const wxString& name,

interface/wx/cursor.h

@@ -190,6 +190,17 @@ public:
     */
     wxCursor(const wxImage& image);
 
+    /**
+        Constructs a cursor from XPM data.
+
+        In versions of wxWidgets until 3.1.6 constructing wxCursor from XPM
+        data implicitly used wxImage constructor from XPM data and wxCursor
+        constructor from wxImage. Since 3.1.6 this constructor overload is
+        available to allow constructing wxCursor from XPM to still work, even
+        though wxImage constructor from XPM is now @c explicit.
+     */
+    wxCursor(const char* const* xpmData);
+
     /**
         Copy constructor, uses @ref overview_refcount "reference counting".
 

src/dfb/cursor.cpp

@@ -53,6 +53,20 @@ void wxCursor::InitFromStock(wxStockCursor cursorId)
 #warning "FIXME -- implement the cursor as bitmaps (that's what DFB uses)"
 }
 
+#if wxUSE_IMAGE
+
+wxCursor::wxCursor(const wxImage& image)
+{
+#warning "FIXME"
+}
+
+wxCursor::wxCursor(const char* const* xpmData)
+{
+#warning "FIXME"
+}
+
+#endif // wxUSE_IMAGE
+
 wxCursor::wxCursor(const wxString& cursor_file,
                    wxBitmapType type,
                    int WXUNUSED(hotSpotX), int WXUNUSED(hotSpotY))

src/gtk/cursor.cpp

@@ -76,6 +76,7 @@ wxCursor::wxCursor(const wxString& cursor_file,
                    wxBitmapType type,
                    int hotSpotX, int hotSpotY)
 {
+#if wxUSE_IMAGE
     wxImage img;
     if (!img.LoadFile(cursor_file, type))
         return;
@@ -95,6 +96,11 @@ wxCursor::wxCursor(const wxImage& img)
 {
     InitFromImage(img);
 }
+
+wxCursor::wxCursor(const char* const* xpmData)
+{
+    InitFromImage(wxImage(xpmData));
+}
 #endif // wxUSE_IMAGE
 
 wxCursor::wxCursor(const char bits[], int width, int height,

src/motif/cursor.cpp

@@ -93,7 +93,7 @@ wxCursor::wxCursor()
 }
 
 #if wxUSE_IMAGE
-wxCursor::wxCursor(const wxImage & image)
+void wxCursor::InitFromImage(const wxImage & image)
 {
     unsigned char * rgbBits = image.GetData();
     int w = image.GetWidth() ;
@@ -174,6 +174,16 @@ wxCursor::wxCursor(const wxImage & image)
     delete[] bits;
     delete[] maskBits;
 }
+
+wxCursor::wxCursor(const wxImage& image)
+{
+    InitFromImage(image);
+}
+
+wxCursor::wxCursor(const char* const* xpmData)
+{
+    InitFromImage(wxImage(xpmData));
+}
 #endif
 
 void wxCursor::Create(const char bits[], int width, int height,

src/msw/cursor.cpp

@@ -153,6 +153,16 @@ wxCursor::wxCursor()
 
 #if wxUSE_IMAGE
 wxCursor::wxCursor(const wxImage& image)
+{
+    InitFromImage(image);
+}
+
+wxCursor::wxCursor(const char* const* xpmData)
+{
+    InitFromImage(wxImage(xpmData));
+}
+
+void wxCursor::InitFromImage(const wxImage& image)
 {
     // image has to be of the standard cursor size, otherwise we won't be able
     // to create it

src/osx/carbon/cursor.cpp

@@ -230,6 +230,11 @@ wxCursor::wxCursor( const wxImage &image )
 {
     InitFromImage( image ) ;
 }
+
+wxCursor::wxCursor(const char* const* xpmData)
+{
+    InitFromImage( wxImage(xpmData) ) ;
+}
 #endif // wxUSE_IMAGE
 
 wxGDIRefData *wxCursor::CreateGDIRefData() const

src/qt/cursor.cpp

@@ -83,6 +83,11 @@ wxCursor::wxCursor(const wxImage& img)
 {
     InitFromImage(img);
 }
+
+wxCursor::wxCursor(const char* const* xpmData)
+{
+    InitFromImage(wxImage(xpmData));
+}
 #endif // wxUSE_IMAGE
 
 wxPoint wxCursor::GetHotSpot() const

src/x11/cursor.cpp

@@ -140,6 +140,11 @@ wxCursor::wxCursor( const wxImage & WXUNUSED(image) )
 {
    wxFAIL_MSG( wxT("wxCursor creation from wxImage not yet implemented") );
 }
+
+wxCursor::wxCursor(const char* const* WXUNUSED(xpmData))
+{
+    wxFAIL_MSG( wxT("wxCursor creation from XPM not yet implemented") );
+}
 #endif
 
 wxCursor::~wxCursor()

tests/image/image.cpp

@@ -21,6 +21,8 @@
 
 #include "wx/anidecod.h" // wxImageArray
 #include "wx/bitmap.h"
+#include "wx/cursor.h"
+#include "wx/icon.h"
 #include "wx/palette.h"
 #include "wx/url.h"
 #include "wx/log.h"
@@ -2164,6 +2166,40 @@ TEST_CASE("wxImage::InitAlpha", "[image][initalpha]")
     }
 }
 
+TEST_CASE("wxImage::XPM", "[image][xpm]")
+{
+   static const char * dummy_xpm[] = {
+      "16 16 2 1",
+      "@ c Black",
+      "  c None",
+      "@               ",
+      " @              ",
+      "  @             ",
+      "   @            ",
+      "    @           ",
+      "     @          ",
+      "      @         ",
+      "       @        ",
+      "        @       ",
+      "         @      ",
+      "          @     ",
+      "           @    ",
+      "            @   ",
+      "             @  ",
+      "              @ ",
+      "               @"
+   };
+
+   wxImage image(dummy_xpm);
+   CHECK( image.IsOk() );
+
+   // The goal here is mostly just to check that this code compiles, i.e. that
+   // creating all these classes from XPM works.
+   CHECK( wxBitmap(dummy_xpm).IsOk() );
+   CHECK( wxCursor(dummy_xpm).IsOk() );
+   CHECK( wxIcon(dummy_xpm).IsOk() );
+}
+
 /*
     TODO: add lots of more tests to wxImage functions
 */