]> git.saurik.com Git - wxWidgets.git/blobdiff - src/gtk/cursor.cpp
Correctly align background brush when erasing owner drawn bitmaps in wxMSW.
[wxWidgets.git] / src / gtk / cursor.cpp
index 26b1bc06295b99b71bf985de13018df7fdb8633a..3ebc5e1a4fce39cc0f9bbf1ccf06d24501d0b611 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        src/gtk/cursor.cpp
-// Purpose:
+// Purpose:     wxCursor implementation
 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
 #include "wx/cursor.h"
 
 #ifndef WX_PRECOMP
+    #include "wx/window.h"
     #include "wx/app.h"
-    #include "wx/utils.h"
     #include "wx/image.h"
-    #include "wx/colour.h"
+    #include "wx/bitmap.h"
+    #include "wx/log.h"
 #endif // WX_PRECOMP
 
-#include "wx/gtk/private.h" //for idle stuff
+#include <gtk/gtk.h>
+#include "wx/gtk/private/object.h"
 
 //-----------------------------------------------------------------------------
-// wxCursor
+// wxCursorRefData
 //-----------------------------------------------------------------------------
 
-class wxCursorRefData: public wxObjectRefData
+class wxCursorRefData: public wxGDIRefData
 {
-  public:
-
+public:
     wxCursorRefData();
     virtual ~wxCursorRefData();
 
+    virtual bool IsOk() const { return m_cursor != NULL; }
+
     GdkCursor *m_cursor;
+
+private:
+    // There is no way to copy m_cursor so we can't implement a copy ctor
+    // properly.
+    wxDECLARE_NO_COPY_CLASS(wxCursorRefData);
 };
 
 wxCursorRefData::wxCursorRefData()
 {
-    m_cursor = (GdkCursor *) NULL;
+    m_cursor = NULL;
 }
 
 wxCursorRefData::~wxCursorRefData()
@@ -45,18 +53,79 @@ wxCursorRefData::~wxCursorRefData()
     if (m_cursor) gdk_cursor_unref( m_cursor );
 }
 
+
 //-----------------------------------------------------------------------------
+// wxCursor
+//-----------------------------------------------------------------------------
+
+#define M_CURSORDATA static_cast<wxCursorRefData*>(m_refData)
+
+IMPLEMENT_DYNAMIC_CLASS(wxCursor, wxGDIObject)
 
-#define M_CURSORDATA ((wxCursorRefData *)m_refData)
+// used in the following two ctors
+extern GtkWidget *wxGetRootWindow();
 
-IMPLEMENT_DYNAMIC_CLASS(wxCursor,wxObject)
 
 wxCursor::wxCursor()
 {
+}
+
+#if wxUSE_IMAGE
+wxCursor::wxCursor(const wxString& cursor_file,
+                   wxBitmapType type,
+                   int hotSpotX, int hotSpotY)
+{
+    wxImage img;
+    if (!img.LoadFile(cursor_file, type))
+        return;
+
+    // eventually set the hotspot:
+    if (!img.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_X))
+        img.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, hotSpotX);
+    if (!img.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y))
+        img.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y, hotSpotY);
+
+    InitFromImage(img);
+}
+
+wxCursor::wxCursor(const wxImage& img)
+{
+    InitFromImage(img);
+}
+#endif
+
+wxCursor::wxCursor(const char bits[], int width, int height,
+                   int hotSpotX, int hotSpotY,
+                   const char maskBits[], const wxColour *fg, const wxColour *bg)
+{
+    if (!maskBits)
+        maskBits = bits;
+    if (!fg)
+        fg = wxBLACK;
+    if (!bg)
+        bg = wxWHITE;
+    if (hotSpotX < 0 || hotSpotX >= width)
+        hotSpotX = 0;
+    if (hotSpotY < 0 || hotSpotY >= height)
+        hotSpotY = 0;
+
+    GdkBitmap *data = gdk_bitmap_create_from_data( wxGetRootWindow()->window, (gchar *) bits, width, height );
+    GdkBitmap *mask = gdk_bitmap_create_from_data( wxGetRootWindow()->window, (gchar *) maskBits, width, height);
+
+    m_refData = new wxCursorRefData;
+    M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixmap(
+                 data, mask, fg->GetColor(), bg->GetColor(),
+                 hotSpotX, hotSpotY );
+
+    g_object_unref (data);
+    g_object_unref (mask);
+}
 
+wxCursor::~wxCursor()
+{
 }
 
-wxCursor::wxCursor( int cursorId )
+void wxCursor::InitFromStock( wxStockCursor cursorId )
 {
     m_refData = new wxCursorRefData();
 
@@ -65,8 +134,8 @@ wxCursor::wxCursor( int cursorId )
     {
         case wxCURSOR_BLANK:
             {
-                static const gchar bits[] = { 0 };
-                static /* const -- not in GTK1 */ GdkColor color = { 0, 0, 0, 0 };
+                const char bits[] = { 0 };
+                const GdkColor color = { 0, 0, 0, 0 };
 
                 GdkPixmap *pixmap = gdk_bitmap_create_from_data(NULL, bits, 1, 1);
                 M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixmap(pixmap,
@@ -74,20 +143,21 @@ wxCursor::wxCursor( int cursorId )
                                                                     &color,
                                                                     &color,
                                                                     0, 0);
+                g_object_unref(pixmap);
             }
             return;
 
         case wxCURSOR_ARROW:            // fall through to default
         case wxCURSOR_DEFAULT:          gdk_cur = GDK_LEFT_PTR; break;
         case wxCURSOR_RIGHT_ARROW:      gdk_cur = GDK_RIGHT_PTR; break;
-        case wxCURSOR_HAND:             gdk_cur = GDK_HAND1; break;
+        case wxCURSOR_HAND:             gdk_cur = GDK_HAND2; break;
         case wxCURSOR_CROSS:            gdk_cur = GDK_CROSSHAIR; break;
         case wxCURSOR_SIZEWE:           gdk_cur = GDK_SB_H_DOUBLE_ARROW; break;
         case wxCURSOR_SIZENS:           gdk_cur = GDK_SB_V_DOUBLE_ARROW; break;
         case wxCURSOR_ARROWWAIT:
         case wxCURSOR_WAIT:
         case wxCURSOR_WATCH:            gdk_cur = GDK_WATCH; break;
-        case wxCURSOR_SIZING:           gdk_cur = GDK_FLEUR; break;
+        case wxCURSOR_SIZING:           gdk_cur = GDK_SIZING; break;
         case wxCURSOR_SPRAYCAN:         gdk_cur = GDK_SPRAYCAN; break;
         case wxCURSOR_IBEAM:            gdk_cur = GDK_XTERM; break;
         case wxCURSOR_PENCIL:           gdk_cur = GDK_PENCIL; break;
@@ -121,220 +191,188 @@ wxCursor::wxCursor( int cursorId )
     M_CURSORDATA->m_cursor = gdk_cursor_new( gdk_cur );
 }
 
-extern GtkWidget *wxGetRootWindow();
+#if wxUSE_IMAGE
 
-wxCursor::wxCursor(const char bits[], int width, int  height,
-                   int hotSpotX, int hotSpotY,
-                   const char maskBits[], const wxColour *fg, const wxColour *bg)
+static void GetHotSpot(const wxImage& image, int& x, int& y)
 {
-    if (!maskBits)
-        maskBits = bits;
-    if (!fg)
-        fg = wxBLACK;
-    if (!bg)
-        bg = wxWHITE;
-    if (hotSpotX < 0 || hotSpotX >= width)
-        hotSpotX = 0;
-    if (hotSpotY < 0 || hotSpotY >= height)
-        hotSpotY = 0;
-
-    GdkBitmap *data = gdk_bitmap_create_from_data( wxGetRootWindow()->window, (gchar *) bits, width, height );
-    GdkBitmap *mask = gdk_bitmap_create_from_data( wxGetRootWindow()->window, (gchar *) maskBits, width, height);
+    if (image.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_X))
+        x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
+    else
+        x = 0;
 
-    m_refData = new wxCursorRefData;
-    M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixmap(
-                 data, mask, fg->GetColor(), bg->GetColor(),
-                 hotSpotX, hotSpotY );
+    if (image.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y))
+        y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
+    else
+        y = 0;
 
-    g_object_unref (data);
-    g_object_unref (mask);
+    if (x < 0 || x >= image.GetWidth())
+        x = 0;
+    if (y < 0 || y >= image.GetHeight())
+        y = 0;
 }
 
-#if wxUSE_IMAGE
-
-wxCursor::wxCursor( const wxImage & image )
+void wxCursor::InitFromImage( const wxImage & image )
 {
-    unsigned char * rgbBits = image.GetData();
     int w = image.GetWidth() ;
     int h = image.GetHeight();
     bool bHasMask = image.HasMask();
-    int imagebitcount = (w*h)/8;
-
-    unsigned char * bits = new unsigned char [imagebitcount];
-    unsigned char * maskBits = new unsigned char [imagebitcount];
+    int hotSpotX, hotSpotY;
+    GetHotSpot(image, hotSpotX, hotSpotY);
+    m_refData = new wxCursorRefData;
+    wxImage image_copy(image);
 
-    int i, j, i8; unsigned char c, cMask;
-    for (i=0; i<imagebitcount; i++)
+    GdkDisplay* display = gdk_drawable_get_display(wxGetRootWindow()->window);
+    if (gdk_display_supports_cursor_color(display))
     {
-        bits[i] = 0;
-        i8 = i * 8;
-
-        cMask = 1;
-        for (j=0; j<8; j++)
+        if (!image.HasAlpha())
         {
-            // possible overflow if we do the summation first ?
-            c = rgbBits[(i8+j)*3]/3 + rgbBits[(i8+j)*3+1]/3 + rgbBits[(i8+j)*3+2]/3;
-            //if average value is > mid grey
-            if (c>127)
-                bits[i] = bits[i] | cMask;
-            cMask = cMask * 2;
+            // add alpha, so wxBitmap will convert to pixbuf format
+            image_copy.InitAlpha();
         }
+        wxBitmap bitmap(image_copy);
+        wxASSERT(bitmap.HasPixbuf());
+        M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixbuf
+                             (
+                              display,
+                              bitmap.GetPixbuf(),
+                              hotSpotX, hotSpotY
+                             );
     }
-
-    unsigned long keyMaskColor;
-    if (bHasMask)
+    else // no colour cursor support
     {
-        unsigned char
-            r = image.GetMaskRed(),
-            g = image.GetMaskGreen(),
-            b = image.GetMaskBlue();
-
-        for (i=0; i<imagebitcount; i++)
+        unsigned long keyMaskColor = 0;
+        GdkPixmap *maskRaw;
+        if (bHasMask)
         {
-            maskBits[i] = 0x0;
-            i8 = i * 8;
-
-            cMask = 1;
-            for (j=0; j<8; j++)
-            {
-                if (rgbBits[(i8+j)*3] != r || rgbBits[(i8+j)*3+1] != g || rgbBits[(i8+j)*3+2] != b)
-                    maskBits[i] = maskBits[i] | cMask;
-                cMask = cMask * 2;
-            }
+            keyMaskColor = wxImageHistogram::MakeKey(
+                image.GetMaskRed(), image.GetMaskGreen(), image.GetMaskBlue());
+            // get mask before image is modified
+            wxBitmap bitmap(image, 1);
+            maskRaw = bitmap.GetMask()->GetBitmap();
+            g_object_ref(maskRaw);
+        }
+        else
+        {
+            const int size = ((w + 7) / 8) * h;
+            char* bits = new char[size];
+            memset(bits, 0xff, size);
+            maskRaw = gdk_bitmap_create_from_data(
+                wxGetRootWindow()->window, bits, w, h);
+            delete[] bits;
         }
 
-        keyMaskColor = (r << 16) | (g << 8) | b;
-    }
-    else // no mask
-    {
-        for (i=0; i<imagebitcount; i++)
-            maskBits[i] = 0xFF;
-
-        // init it to avoid compiler warnings
-        keyMaskColor = 0;
-    }
+        // assign the raw pointer to wxGtkObject to ensure it is unref'd later
+        wxGtkObject<GdkPixmap> mask(maskRaw);
 
-    // find the most frequent color(s)
-    wxImageHistogram histogram;
-    image.ComputeHistogram(histogram);
-
-    // colors as rrggbb
-    unsigned long key;
-    unsigned long value;
-
-    long colMostFreq = 0;
-    unsigned long nMost = 0;
-    long colNextMostFreq = 0;
-    unsigned long nNext = 0;
-    for ( wxImageHistogram::iterator entry = histogram.begin();
-          entry != histogram.end();
-          ++entry )
-    {
-        value = entry->second.value;
-        key = entry->first;
-        if ( !bHasMask || (key != keyMaskColor) )
+        // modify image so wxBitmap can be used to convert to pixmap
+        image_copy.SetMask(false);
+        wxByte* data = image_copy.GetData();
+        for (int j = 0; j < h; j++)
         {
-            if (value > nMost)
+            for (int i = 0; i < w; i++, data += 3)
             {
-                nMost = value;
-                colMostFreq = key;
+                // if average value of the pixel is > mid grey, convert it to
+                // background (0), otherwise to foreground (255, using wxBitmap
+                // convention)
+                data[0] =
+                data[1] =
+                data[2] = int(data[0]) + data[1] + data[2] >= 3 * 128 ? 0 : 255;
             }
-            else if (value > nNext)
+        }
+        wxBitmap bitmap(image_copy, 1);
+
+        // find the most frequent color(s)
+        wxImageHistogram histogram;
+        image.ComputeHistogram(histogram);
+
+        long colMostFreq = 0;
+        unsigned long nMost = 0;
+        long colNextMostFreq = 0;
+        unsigned long nNext = 0;
+        for ( wxImageHistogram::iterator entry = histogram.begin();
+              entry != histogram.end();
+              ++entry )
+        {
+            unsigned long key = entry->first;
+            if ( !bHasMask || (key != keyMaskColor) )
             {
-                nNext = value;
-                colNextMostFreq = key;
+                unsigned long value = entry->second.value;
+                if (value > nMost)
+                {
+                    nNext = nMost;
+                    colNextMostFreq = colMostFreq;
+                    nMost = value;
+                    colMostFreq = key;
+                }
+                else if (value > nNext)
+                {
+                    nNext = value;
+                    colNextMostFreq = key;
+                }
             }
         }
-    }
-
-    wxColour fg = wxColour ( (unsigned char)(colMostFreq >> 16),
-                             (unsigned char)(colMostFreq >> 8),
-                             (unsigned char)(colMostFreq) );
 
-    wxColour bg = wxColour ( (unsigned char)(colNextMostFreq >> 16),
-                             (unsigned char)(colNextMostFreq >> 8),
-                             (unsigned char)(colNextMostFreq) );
+        wxColour fg = wxColour ( (unsigned char)(colMostFreq >> 16),
+                                 (unsigned char)(colMostFreq >> 8),
+                                 (unsigned char)(colMostFreq) );
 
-    int fg_intensity = fg.Red() + fg.Green() + fg.Blue();
-    int bg_intensity = bg.Red() + bg.Green() + bg.Blue();
+        wxColour bg = wxColour ( (unsigned char)(colNextMostFreq >> 16),
+                                 (unsigned char)(colNextMostFreq >> 8),
+                                 (unsigned char)(colNextMostFreq) );
 
-    if (bg_intensity > fg_intensity)
-    {
-        //swap fg and bg
-        wxColour tmp = fg;
-        fg = bg;
-        bg = tmp;
-    }
-
-    int hotSpotX;
-    int hotSpotY;
+        int fg_intensity = fg.Red() + fg.Green() + fg.Blue();
+        int bg_intensity = bg.Red() + bg.Green() + bg.Blue();
 
-    if (image.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_X))
-        hotSpotX = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
-    else
-        hotSpotX = 0;
-
-    if (image.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y))
-        hotSpotY = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
-    else
-        hotSpotY = 0;
-
-    if (hotSpotX < 0 || hotSpotX >= w)
-        hotSpotX = 0;
-    if (hotSpotY < 0 || hotSpotY >= h)
-        hotSpotY = 0;
-
-    GdkBitmap *data = gdk_bitmap_create_from_data(wxGetRootWindow()->window,
-                                                  (gchar *) bits, w, h);
-    GdkBitmap *mask = gdk_bitmap_create_from_data(wxGetRootWindow()->window,
-                                                  (gchar *) maskBits, w, h);
-
-    m_refData = new wxCursorRefData;
-    M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixmap
-                             (
-                                data,
-                                mask,
-                                fg.GetColor(), bg.GetColor(),
-                                hotSpotX, hotSpotY
-                             );
+        if (bg_intensity > fg_intensity)
+        {
+            //swap fg and bg
+            wxColour tmp = fg;
+            fg = bg;
+            bg = tmp;
+        }
 
-    g_object_unref (data);
-    g_object_unref (mask);
-    delete [] bits;
-    delete [] maskBits;
+        M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixmap
+                                 (
+                                    bitmap.GetPixmap(),
+                                    mask,
+                                    fg.GetColor(), bg.GetColor(),
+                                    hotSpotX, hotSpotY
+                                 );
+    }
 }
 
 #endif // wxUSE_IMAGE
 
-wxCursor::~wxCursor()
-{
-}
-
-bool wxCursor::operator == ( const wxCursor& cursor ) const
+GdkCursor *wxCursor::GetCursor() const
 {
-    return m_refData == cursor.m_refData;
+    return M_CURSORDATA->m_cursor;
 }
 
-bool wxCursor::operator != ( const wxCursor& cursor ) const
+wxGDIRefData *wxCursor::CreateGDIRefData() const
 {
-    return m_refData != cursor.m_refData;
+    return new wxCursorRefData;
 }
 
-bool wxCursor::IsOk() const
+wxGDIRefData *
+wxCursor::CloneGDIRefData(const wxGDIRefData * WXUNUSED(data)) const
 {
-    return (m_refData != NULL);
-}
-
-GdkCursor *wxCursor::GetCursor() const
-{
-    return M_CURSORDATA->m_cursor;
+    // TODO: We can't clone GDK cursors at the moment. To do this we'd need
+    //       to remember the original data from which the cursor was created
+    //       (i.e. standard cursor type or the bitmap) or use
+    //       gdk_cursor_get_cursor_type() (which is in 2.22+ only) and
+    //       gdk_cursor_get_image().
+    wxFAIL_MSG( wxS("Cloning cursors is not implemented in wxGTK.") );
+
+    return new wxCursorRefData;
 }
 
 //-----------------------------------------------------------------------------
 // busy cursor routines
 //-----------------------------------------------------------------------------
 
-extern wxCursor g_globalCursor;
+/* Current cursor, in order to hang on to
+ * cursor handle when setting the cursor globally */
+wxCursor g_globalCursor;
 
 static wxCursor  gs_savedCursor;
 static int       gs_busyCount = 0;
@@ -349,19 +387,31 @@ const wxCursor wxBusyCursor::GetBusyCursor()
     return wxCursor(wxCURSOR_WATCH);
 }
 
+static void UpdateCursors(const wxWindowList& list, GdkDisplay*& display)
+{
+    wxWindowList::const_iterator i = list.begin();
+    for (size_t n = list.size(); n--; ++i)
+    {
+        wxWindow* win = *i;
+        if (display == NULL && win->m_widget && win->m_widget->window)
+            display = gdk_drawable_get_display(win->m_widget->window);
+        win->GTKUpdateCursor(true, false);
+        UpdateCursors(win->GetChildren(), display);
+    }
+}
+
 void wxEndBusyCursor()
 {
     if (--gs_busyCount > 0)
         return;
 
-    wxSetCursor( gs_savedCursor );
+    g_globalCursor = gs_savedCursor;
     gs_savedCursor = wxNullCursor;
-
-    if (wxTheApp)
-        wxTheApp->ProcessIdle();
+    GdkDisplay* unused = NULL;
+    UpdateCursors(wxTopLevelWindows, unused);
 }
 
-void wxBeginBusyCursor( const wxCursor *WXUNUSED(cursor) )
+void wxBeginBusyCursor(const wxCursor* cursor)
 {
     if (gs_busyCount++ > 0)
         return;
@@ -370,13 +420,11 @@ void wxBeginBusyCursor( const wxCursor *WXUNUSED(cursor) )
                   wxT("forgot to call wxEndBusyCursor, will leak memory") );
 
     gs_savedCursor = g_globalCursor;
-
-    wxSetCursor( wxCursor(wxCURSOR_WATCH) );
-
-    if (wxTheApp)
-        wxTheApp->ProcessIdle();
-
-    gdk_flush();
+    g_globalCursor = *cursor;
+    GdkDisplay* display = NULL;
+    UpdateCursors(wxTopLevelWindows, display);
+    if (display)
+        gdk_display_flush(display);
 }
 
 bool wxIsBusy()
@@ -386,8 +434,7 @@ bool wxIsBusy()
 
 void wxSetCursor( const wxCursor& cursor )
 {
-    if (g_isIdle)
-        wxapp_install_idle_handler();
-
     g_globalCursor = cursor;
+    GdkDisplay* unused = NULL;
+    UpdateCursors(wxTopLevelWindows, unused);
 }