fix the definition of many static functions marked as 'const' or functions which...

[wxWidgets.git] / src / gtk / cursor.cpp

diff --git a/src/gtk/cursor.cpp b/src/gtk/cursor.cpp
index bb0888bdcb1d10a36b2b90909945dc9c4b24ab86..14007740594a9c26a7fe82b9d830cfb04a562986 100644 (file)
--- a/src/gtk/cursor.cpp
+++ b/src/gtk/cursor.cpp
@@ -1,173 +1,437 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        cursor.cpp
+// Name:        src/gtk/cursor.cpp

 // Purpose:
 // Author:      Robert Roebling
 // Purpose:
 // Author:      Robert Roebling

-// Created:     01/02/97
-// Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// Id:          $Id$
+// Copyright:   (c) 1998 Robert Roebling
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-
-#ifdef __GNUG__
-#pragma implementation "cursor.h"
-#endif
+// For compilers that support precompilation, includes "wx.h".
+#include "wx/wxprec.h"

 
 #include "wx/cursor.h"
 
 
 #include "wx/cursor.h"
 

+#ifndef WX_PRECOMP
+    #include "wx/window.h"
+    #include "wx/app.h"
+    #include "wx/image.h"
+    #include "wx/bitmap.h"
+    #include "wx/log.h"
+#endif // WX_PRECOMP
+
+#include <gtk/gtk.h>
+

 //-----------------------------------------------------------------------------
 // wxCursor
 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 // wxCursor
 //-----------------------------------------------------------------------------
 

-class wxCursorRefData: public wxObjectRefData
+class wxCursorRefData: public wxGDIRefData

 {
 {

-  public:
-  
-    wxCursorRefData(void);
-    ~wxCursorRefData(void);
-  
+public:
+    wxCursorRefData();
+    virtual ~wxCursorRefData();
+
+    virtual bool IsOk() const { return m_cursor != NULL; }
+

     GdkCursor *m_cursor;
 };
 
     GdkCursor *m_cursor;
 };
 

-wxCursorRefData::wxCursorRefData(void)
+wxCursorRefData::wxCursorRefData()

 {
 {

-  m_cursor = NULL;
-};
+    m_cursor = (GdkCursor *) NULL;
+}

 
 

-wxCursorRefData::~wxCursorRefData(void)
+wxCursorRefData::~wxCursorRefData()

 {
 {

-  if (m_cursor) gdk_cursor_destroy( m_cursor );
-};
+    if (m_cursor) gdk_cursor_unref( m_cursor );
+}

 
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------
 

-#define M_CURSORDATA ((wxCursorRefData *)m_refData)
+#define M_CURSORDATA static_cast<wxCursorRefData*>(m_refData)

 
 

-IMPLEMENT_DYNAMIC_CLASS(wxCursor,wxObject)
+IMPLEMENT_DYNAMIC_CLASS(wxCursor, wxGDIObject)

 
 

-wxCursor::wxCursor(void)
+wxCursor::wxCursor()

 {
 {

-};
+}

 
 

-wxCursor::wxCursor( const int cursorId )
-{
-  m_refData = new wxCursorRefData();
-  
-  GdkCursorType gdk_cur = GDK_LEFT_PTR;
-  switch (cursorId)
-  {
-    case wxCURSOR_HAND:       gdk_cur = GDK_HAND1; 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_WAIT:       gdk_cur = GDK_WATCH; break;
-    case wxCURSOR_WATCH:      gdk_cur = GDK_WATCH; 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;
-    case wxCURSOR_NO_ENTRY:   gdk_cur = GDK_PIRATE; break;
-  };
-  
-  M_CURSORDATA->m_cursor = gdk_cursor_new( gdk_cur );
-  
+void wxCursor::InitFromStock( wxStockCursor cursorId )
+{
+    m_refData = new wxCursorRefData();
+
+    GdkCursorType gdk_cur = GDK_LEFT_PTR;
+    switch (cursorId)
+    {
+        case wxCURSOR_BLANK:
+            {
+                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,
+                                                                    pixmap,
+                                                                    &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_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_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;
+        case wxCURSOR_NO_ENTRY:         gdk_cur = GDK_PIRATE; break;
+        case wxCURSOR_SIZENWSE:
+        case wxCURSOR_SIZENESW:         gdk_cur = GDK_FLEUR; break;
+        case wxCURSOR_QUESTION_ARROW:   gdk_cur = GDK_QUESTION_ARROW; break;
+        case wxCURSOR_PAINT_BRUSH:      gdk_cur = GDK_SPRAYCAN; break;
+        case wxCURSOR_MAGNIFIER:        gdk_cur = GDK_PLUS; break;
+        case wxCURSOR_CHAR:             gdk_cur = GDK_XTERM; break;
+        case wxCURSOR_LEFT_BUTTON:      gdk_cur = GDK_LEFTBUTTON; break;
+        case wxCURSOR_MIDDLE_BUTTON:    gdk_cur = GDK_MIDDLEBUTTON; break;
+        case wxCURSOR_RIGHT_BUTTON:     gdk_cur = GDK_RIGHTBUTTON; break;
+        case wxCURSOR_BULLSEYE:         gdk_cur = GDK_TARGET; break;
+
+        case wxCURSOR_POINT_LEFT:       gdk_cur = GDK_SB_LEFT_ARROW; break;
+        case wxCURSOR_POINT_RIGHT:      gdk_cur = GDK_SB_RIGHT_ARROW; break;

 /*
 /*

-  do that yourself
-   
-  wxCURSOR_BULLSEYE,
-  wxCURSOR_CHAR,
-  wxCURSOR_LEFT_BUTTON,
-  wxCURSOR_MAGNIFIER,
-  wxCURSOR_MIDDLE_BUTTON,
-  wxCURSOR_NO_ENTRY,
-  wxCURSOR_PAINT_BRUSH,
-  wxCURSOR_POINT_LEFT,
-  wxCURSOR_POINT_RIGHT,
-  wxCURSOR_QUESTION_ARROW,
-  wxCURSOR_RIGHT_BUTTON,
-  wxCURSOR_SIZENESW,
-  wxCURSOR_SIZENS,
-  wxCURSOR_SIZENWSE,
-  wxCURSOR_SIZEWE,
-  wxCURSOR_BLANK
-,
-  wxCURSOR_CROSS_REVERSE,
-  wxCURSOR_DOUBLE_ARROW,
-  wxCURSOR_BASED_ARROW_UP,
-  wxCURSOR_BASED_ARROW_DOWN
+        case wxCURSOR_DOUBLE_ARROW:     gdk_cur = GDK_DOUBLE_ARROW; break;
+        case wxCURSOR_CROSS_REVERSE:    gdk_cur = GDK_CROSS_REVERSE; break;
+        case wxCURSOR_BASED_ARROW_UP:   gdk_cur = GDK_BASED_ARROW_UP; break;
+        case wxCURSOR_BASED_ARROW_DOWN: gdk_cur = GDK_BASED_ARROW_DOWN; break;

 */
 */

-   
-};

 
 

-wxCursor::wxCursor( const wxCursor &cursor )
+        default:
+            wxFAIL_MSG(wxT("unsupported cursor type"));
+            // will use the standard one
+            break;
+    }
+
+    M_CURSORDATA->m_cursor = gdk_cursor_new( gdk_cur );
+}
+
+
+// used in the following two ctors
+extern GtkWidget *wxGetRootWindow();
+
+wxCursor::wxCursor(const wxString& cursor_file,
+                   wxBitmapType type,
+                   int hotSpotX, int hotSpotY)

 {
 {

-  Ref( cursor );
-};
+    /* TODO: test this code! */
+
+    // Must be an XBM file
+    if (type != wxBITMAP_TYPE_XPM) {
+        wxLogError("Invalid cursor bitmap type '%d'", type);
+        return;
+    }
+
+    // load the XPM
+    GdkBitmap *mask = NULL;
+    GdkBitmap *data = gdk_pixmap_create_from_xpm( wxGetRootWindow()->window,
+                                                  &mask, NULL, cursor_file.mb_str() );
+    if (!data)
+        return;
+
+    // check given hotspot
+    gint w, h;
+    gdk_drawable_get_size( data, &w, &h );
+    if (hotSpotX < 0 || hotSpotX >= w)
+        hotSpotX = 0;
+    if (hotSpotY < 0 || hotSpotY >= h)
+        hotSpotY = 0;
+
+    // create the real cursor
+    m_refData = new wxCursorRefData;
+    M_CURSORDATA->m_cursor =
+        gdk_cursor_new_from_pixmap( data, mask,
+                                    wxBLACK->GetColor(), wxWHITE->GetColor(),
+                                    hotSpotX, hotSpotY );
+
+    g_object_unref (data);
+    g_object_unref (mask);
+}

 
 

-wxCursor::wxCursor( const wxCursor *cursor )
+wxCursor::wxCursor(const char bits[], int width, int height,
+                   int hotSpotX, int hotSpotY,
+                   const char maskBits[], const wxColour *fg, const wxColour *bg)

 {
 {

-  UnRef();
-  if (cursor) Ref( *cursor );
-};
+    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(void)
+#if wxUSE_IMAGE
+
+static void GetHotSpot(const wxImage& image, int& x, int& y)

 {
 {

-};
+    if (image.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_X))
+        x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
+    else
+        x = 0;
+
+    if (image.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y))
+        y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
+    else
+        y = 0;

 
 

-wxCursor& wxCursor::operator = ( const wxCursor& cursor )
+    if (x < 0 || x >= image.GetWidth())
+        x = 0;
+    if (y < 0 || y >= image.GetHeight())
+        y = 0;
+}
+
+wxCursor::wxCursor( const wxImage & image )

 {
 {

-  if (*this == cursor) return (*this); 
-  Ref( cursor ); 
-  return *this; 
-};
+    int w = image.GetWidth() ;
+    int h = image.GetHeight();
+    bool bHasMask = image.HasMask();
+    int hotSpotX, hotSpotY;
+    GetHotSpot(image, hotSpotX, hotSpotY);
+    m_refData = new wxCursorRefData;
+    wxImage image_copy(image);
+
+    GdkDisplay* display = gdk_drawable_get_display(wxGetRootWindow()->window);
+    if (gdk_display_supports_cursor_color(display))
+    {
+        if (!image.HasAlpha())
+        {
+            // 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
+                             );
+        return;
+    }
+
+    unsigned long keyMaskColor = 0;
+    GdkPixmap* mask;
+    if (bHasMask)
+    {
+        keyMaskColor = wxImageHistogram::MakeKey(
+            image.GetMaskRed(), image.GetMaskGreen(), image.GetMaskBlue());
+        // get mask before image is modified
+        wxBitmap bitmap(image, 1);
+        mask = bitmap.GetMask()->GetBitmap();
+        g_object_ref(mask);
+    }
+    else
+    {
+        const int size = ((w + 7) / 8) * h;
+        char* bits = new char[size];
+        memset(bits, 0xff, size);
+        mask = gdk_bitmap_create_from_data(
+            wxGetRootWindow()->window, bits, w, h);
+        delete[] bits;
+    }
+
+    // modify image so wxBitmap can be used to convert to pixmap
+    image_copy.SetMask(false);
+    int i, j;
+    wxByte* data = image_copy.GetData();
+    for (j = 0; j < h; j++)
+    {
+        for (i = 0; i < w; i++, data += 3)
+        {
+            //if average value is > mid grey
+            if (int(data[0]) + data[1] + data[2] >= 3 * 128)
+            {
+                // wxBitmap only converts (255,255,255) to white
+                data[0] = 255;
+                data[1] = 255;
+                data[2] = 255;
+            }
+        }
+    }
+    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) )
+        {
+            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) );

 
 

-bool wxCursor::operator == ( const wxCursor& cursor )
+    wxColour bg = wxColour ( (unsigned char)(colNextMostFreq >> 16),
+                             (unsigned char)(colNextMostFreq >> 8),
+                             (unsigned char)(colNextMostFreq) );
+
+    int fg_intensity = fg.Red() + fg.Green() + fg.Blue();
+    int bg_intensity = bg.Red() + bg.Green() + bg.Blue();
+
+    if (bg_intensity > fg_intensity)
+    {
+        //swap fg and bg
+        wxColour tmp = fg;
+        fg = bg;
+        bg = tmp;
+    }
+
+    M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixmap
+                             (
+                                bitmap.GetPixmap(),
+                                mask,
+                                fg.GetColor(), bg.GetColor(),
+                                hotSpotX, hotSpotY
+                             );
+
+    g_object_unref (mask);
+}
+
+#endif // wxUSE_IMAGE
+
+wxCursor::~wxCursor()

 {
 {

-  return m_refData == cursor.m_refData; 
-};
+}

 
 

-bool wxCursor::operator != ( const wxCursor& cursor )
+GdkCursor *wxCursor::GetCursor() const

 {
 {

-  return m_refData != cursor.m_refData; 
-};
+    return M_CURSORDATA->m_cursor;
+}

 
 

-bool wxCursor::Ok(void) const
+wxGDIRefData *wxCursor::CreateGDIRefData() const

 {
 {

-  return TRUE;
-};
+    return new wxCursorRefData;
+}

 
 

-GdkCursor *wxCursor::GetCursor(void) const
+wxGDIRefData *wxCursor::CloneGDIRefData(const wxGDIRefData *data) const

 {
 {

-  return M_CURSORDATA->m_cursor;
-};
+    return new wxCursorRefData(*static_cast<const wxCursorRefData *>(data));
+}

 
 //-----------------------------------------------------------------------------
 // busy cursor routines
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------
 // busy cursor routines
 //-----------------------------------------------------------------------------
 

-bool g_isBusy = FALSE;
+/* Current cursor, in order to hang on to
+ * cursor handle when setting the cursor globally */
+wxCursor g_globalCursor;

 
 

-void wxEndBusyCursor(void)
+static wxCursor  gs_savedCursor;
+static int       gs_busyCount = 0;
+
+const wxCursor &wxBusyCursor::GetStoredCursor()

 {
 {

-  g_isBusy = FALSE;
-};
+    return gs_savedCursor;
+}

 
 

-void wxBeginBusyCursor( wxCursor *WXUNUSED(cursor) )
+const wxCursor wxBusyCursor::GetBusyCursor()

 {
 {

-  g_isBusy = TRUE;
-};
+    return wxCursor(wxCURSOR_WATCH);
+}

 
 

-bool wxIsBusy(void)
+static void InternalIdle(const wxWindowList& list, GdkDisplay*& display)

 {
 {

-  return g_isBusy;
-};
+    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->OnInternalIdle();
+        InternalIdle(win->GetChildren(), display);
+    }
+}

 
 

-void wxSetCursor( const wxCursor& cursor )
+void wxEndBusyCursor()

 {
 {

-  extern wxCursor *g_globalCursor;
-  if (g_globalCursor) (*g_globalCursor) = cursor;
+    if (--gs_busyCount > 0)
+        return;

 
 

-  if (cursor.Ok()) {};
-};
+    g_globalCursor = gs_savedCursor;
+    gs_savedCursor = wxNullCursor;
+    GdkDisplay* unused = NULL;
+    InternalIdle(wxTopLevelWindows, unused);
+}

 
 

+void wxBeginBusyCursor(const wxCursor* cursor)
+{
+    if (gs_busyCount++ > 0)
+        return;
+
+    wxASSERT_MSG( !gs_savedCursor.Ok(),
+                  wxT("forgot to call wxEndBusyCursor, will leak memory") );

 
 

+    gs_savedCursor = g_globalCursor;
+    g_globalCursor = *cursor;
+    GdkDisplay* display = NULL;
+    InternalIdle(wxTopLevelWindows, display);
+    if (display)
+        gdk_display_flush(display);
+}
+
+bool wxIsBusy()
+{
+    return gs_busyCount > 0;
+}
+
+void wxSetCursor( const wxCursor& cursor )
+{
+    g_globalCursor = cursor;
+    wxTheApp->WakeUpIdle();
+}