src/gtk/cursor.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/cursor.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 // For compilers that support precompilation, includes "wx.h".
  11 #include "wx/wxprec.h"
  12
  13 #include "wx/cursor.h"
  14
  15 #ifndef WX_PRECOMP
  16     #include "wx/app.h"
  17     #include "wx/utils.h"
  18 #endif // WX_PRECOMP
  19
  20 #include "wx/gtk/private.h" //for idle stuff
  21
  22 #include <gdk/gdk.h>
  23 #include <gtk/gtk.h>
  24
  25 //-----------------------------------------------------------------------------
  26 // wxCursor
  27 //-----------------------------------------------------------------------------
  28
  29 class wxCursorRefData: public wxObjectRefData
  30 {
  31   public:
  32
  33     wxCursorRefData();
  34     ~wxCursorRefData();
  35
  36     GdkCursor *m_cursor;
  37 };
  38
  39 wxCursorRefData::wxCursorRefData()
  40 {
  41     m_cursor = (GdkCursor *) NULL;
  42 }
  43
  44 wxCursorRefData::~wxCursorRefData()
  45 {
  46     if (m_cursor) gdk_cursor_unref( m_cursor );
  47 }
  48
  49 //-----------------------------------------------------------------------------
  50
  51 #define M_CURSORDATA ((wxCursorRefData *)m_refData)
  52
  53 IMPLEMENT_DYNAMIC_CLASS(wxCursor,wxObject)
  54
  55 wxCursor::wxCursor()
  56 {
  57
  58 }
  59
  60 wxCursor::wxCursor( int cursorId )
  61 {
  62     m_refData = new wxCursorRefData();
  63
  64     GdkCursorType gdk_cur = GDK_LEFT_PTR;
  65     switch (cursorId)
  66     {
  67         case wxCURSOR_BLANK:
  68             {
  69                 static const gchar bits[] = { 0 };
  70                 static /* const -- not in GTK1 */ GdkColor color = { 0, 0, 0, 0 };
  71
  72                 GdkPixmap *pixmap = gdk_bitmap_create_from_data(NULL, bits, 1, 1);
  73                 M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixmap(pixmap,
  74                                                                     pixmap,
  75                                                                     &color,
  76                                                                     &color,
  77                                                                     0, 0);
  78             }
  79             return;
  80
  81         case wxCURSOR_ARROW:            // fall through to default
  82         case wxCURSOR_DEFAULT:          gdk_cur = GDK_LEFT_PTR; break;
  83         case wxCURSOR_RIGHT_ARROW:      gdk_cur = GDK_RIGHT_PTR; break;
  84         case wxCURSOR_HAND:             gdk_cur = GDK_HAND1; break;
  85         case wxCURSOR_CROSS:            gdk_cur = GDK_CROSSHAIR; break;
  86         case wxCURSOR_SIZEWE:           gdk_cur = GDK_SB_H_DOUBLE_ARROW; break;
  87         case wxCURSOR_SIZENS:           gdk_cur = GDK_SB_V_DOUBLE_ARROW; break;
  88         case wxCURSOR_ARROWWAIT:
  89         case wxCURSOR_WAIT:
  90         case wxCURSOR_WATCH:            gdk_cur = GDK_WATCH; break;
  91         case wxCURSOR_SIZING:           gdk_cur = GDK_SIZING; break;
  92         case wxCURSOR_SPRAYCAN:         gdk_cur = GDK_SPRAYCAN; break;
  93         case wxCURSOR_IBEAM:            gdk_cur = GDK_XTERM; break;
  94         case wxCURSOR_PENCIL:           gdk_cur = GDK_PENCIL; break;
  95         case wxCURSOR_NO_ENTRY:         gdk_cur = GDK_PIRATE; break;
  96         case wxCURSOR_SIZENWSE:
  97         case wxCURSOR_SIZENESW:         gdk_cur = GDK_FLEUR; break;
  98         case wxCURSOR_QUESTION_ARROW:   gdk_cur = GDK_QUESTION_ARROW; break;
  99         case wxCURSOR_PAINT_BRUSH:      gdk_cur = GDK_SPRAYCAN; break;
 100         case wxCURSOR_MAGNIFIER:        gdk_cur = GDK_PLUS; break;
 101         case wxCURSOR_CHAR:             gdk_cur = GDK_XTERM; break;
 102         case wxCURSOR_LEFT_BUTTON:      gdk_cur = GDK_LEFTBUTTON; break;
 103         case wxCURSOR_MIDDLE_BUTTON:    gdk_cur = GDK_MIDDLEBUTTON; break;
 104         case wxCURSOR_RIGHT_BUTTON:     gdk_cur = GDK_RIGHTBUTTON; break;
 105         case wxCURSOR_BULLSEYE:         gdk_cur = GDK_TARGET; break;
 106
 107         case wxCURSOR_POINT_LEFT:       gdk_cur = GDK_SB_LEFT_ARROW; break;
 108         case wxCURSOR_POINT_RIGHT:      gdk_cur = GDK_SB_RIGHT_ARROW; break;
 109 /*
 110         case wxCURSOR_DOUBLE_ARROW:     gdk_cur = GDK_DOUBLE_ARROW; break;
 111         case wxCURSOR_CROSS_REVERSE:    gdk_cur = GDK_CROSS_REVERSE; break;
 112         case wxCURSOR_BASED_ARROW_UP:   gdk_cur = GDK_BASED_ARROW_UP; break;
 113         case wxCURSOR_BASED_ARROW_DOWN: gdk_cur = GDK_BASED_ARROW_DOWN; break;
 114 */
 115
 116         default:
 117             wxFAIL_MSG(wxT("unsupported cursor type"));
 118             // will use the standard one
 119             break;
 120     }
 121
 122     M_CURSORDATA->m_cursor = gdk_cursor_new( gdk_cur );
 123 }
 124
 125 extern GtkWidget *wxGetRootWindow();
 126
 127 wxCursor::wxCursor(const char bits[], int width, int  height,
 128                    int hotSpotX, int hotSpotY,
 129                    const char maskBits[], const wxColour *fg, const wxColour *bg)
 130 {
 131     if (!maskBits)
 132         maskBits = bits;
 133     if (!fg)
 134         fg = wxBLACK;
 135     if (!bg)
 136         bg = wxWHITE;
 137     if (hotSpotX < 0 || hotSpotX >= width)
 138         hotSpotX = 0;
 139     if (hotSpotY < 0 || hotSpotY >= height)
 140         hotSpotY = 0;
 141
 142     GdkBitmap *data = gdk_bitmap_create_from_data( wxGetRootWindow()->window, (gchar *) bits, width, height );
 143     GdkBitmap *mask = gdk_bitmap_create_from_data( wxGetRootWindow()->window, (gchar *) maskBits, width, height);
 144
 145     m_refData = new wxCursorRefData;
 146     M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixmap(
 147                  data, mask,
 148 #if GTK_CHECK_VERSION(2, 6, 0)
 149                  fg->GetColor(), bg->GetColor(),
 150 #else
 151                  wx_const_cast(GdkColor*, fg->GetColor()), wx_const_cast(GdkColor*, bg->GetColor()),
 152 #endif
 153                  hotSpotX, hotSpotY );
 154
 155     g_object_unref (data);
 156     g_object_unref (mask);
 157 }
 158
 159 #if wxUSE_IMAGE
 160
 161 wxCursor::wxCursor( const wxImage & image )
 162 {
 163     unsigned char * rgbBits = image.GetData();
 164     int w = image.GetWidth() ;
 165     int h = image.GetHeight();
 166     bool bHasMask = image.HasMask();
 167     int imagebitcount = (w*h)/8;
 168
 169     unsigned char * bits = new unsigned char [imagebitcount];
 170     unsigned char * maskBits = new unsigned char [imagebitcount];
 171
 172     int i, j, i8; unsigned char c, cMask;
 173     for (i=0; i<imagebitcount; i++)
 174     {
 175         bits[i] = 0;
 176         i8 = i * 8;
 177
 178         cMask = 1;
 179         for (j=0; j<8; j++)
 180         {
 181             // possible overflow if we do the summation first ?
 182             c = rgbBits[(i8+j)*3]/3 + rgbBits[(i8+j)*3+1]/3 + rgbBits[(i8+j)*3+2]/3;
 183             //if average value is > mid grey
 184             if (c>127)
 185                 bits[i] = bits[i] | cMask;
 186             cMask = cMask * 2;
 187         }
 188     }
 189
 190     unsigned long keyMaskColor;
 191     if (bHasMask)
 192     {
 193         unsigned char
 194             r = image.GetMaskRed(),
 195             g = image.GetMaskGreen(),
 196             b = image.GetMaskBlue();
 197
 198         for (i=0; i<imagebitcount; i++)
 199         {
 200             maskBits[i] = 0x0;
 201             i8 = i * 8;
 202
 203             cMask = 1;
 204             for (j=0; j<8; j++)
 205             {
 206                 if (rgbBits[(i8+j)*3] != r || rgbBits[(i8+j)*3+1] != g || rgbBits[(i8+j)*3+2] != b)
 207                     maskBits[i] = maskBits[i] | cMask;
 208                 cMask = cMask * 2;
 209             }
 210         }
 211
 212         keyMaskColor = (r << 16) | (g << 8) | b;
 213     }
 214     else // no mask
 215     {
 216         for (i=0; i<imagebitcount; i++)
 217             maskBits[i] = 0xFF;
 218
 219         // init it to avoid compiler warnings
 220         keyMaskColor = 0;
 221     }
 222
 223     // find the most frequent color(s)
 224     wxImageHistogram histogram;
 225     image.ComputeHistogram(histogram);
 226
 227     // colors as rrggbb
 228     unsigned long key;
 229     unsigned long value;
 230
 231     long colMostFreq = 0;
 232     unsigned long nMost = 0;
 233     long colNextMostFreq = 0;
 234     unsigned long nNext = 0;
 235     for ( wxImageHistogram::iterator entry = histogram.begin();
 236           entry != histogram.end();
 237           ++entry )
 238     {
 239         value = entry->second.value;
 240         key = entry->first;
 241         if ( !bHasMask || (key != keyMaskColor) )
 242         {
 243             if (value > nMost)
 244             {
 245                 nMost = value;
 246                 colMostFreq = key;
 247             }
 248             else if (value > nNext)
 249             {
 250                 nNext = value;
 251                 colNextMostFreq = key;
 252             }
 253         }
 254     }
 255
 256     wxColour fg = wxColour ( (unsigned char)(colMostFreq >> 16),
 257                              (unsigned char)(colMostFreq >> 8),
 258                              (unsigned char)(colMostFreq) );
 259
 260     wxColour bg = wxColour ( (unsigned char)(colNextMostFreq >> 16),
 261                              (unsigned char)(colNextMostFreq >> 8),
 262                              (unsigned char)(colNextMostFreq) );
 263
 264     int fg_intensity = fg.Red() + fg.Green() + fg.Blue();
 265     int bg_intensity = bg.Red() + bg.Green() + bg.Blue();
 266
 267     if (bg_intensity > fg_intensity)
 268     {
 269         //swap fg and bg
 270         wxColour tmp = fg;
 271         fg = bg;
 272         bg = tmp;
 273     }
 274
 275     int hotSpotX;
 276     int hotSpotY;
 277
 278     if (image.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_X))
 279         hotSpotX = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
 280     else
 281         hotSpotX = 0;
 282
 283     if (image.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y))
 284         hotSpotY = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
 285     else
 286         hotSpotY = 0;
 287
 288     if (hotSpotX < 0 || hotSpotX >= w)
 289         hotSpotX = 0;
 290     if (hotSpotY < 0 || hotSpotY >= h)
 291         hotSpotY = 0;
 292
 293     GdkBitmap *data = gdk_bitmap_create_from_data(wxGetRootWindow()->window,
 294                                                   (gchar *) bits, w, h);
 295     GdkBitmap *mask = gdk_bitmap_create_from_data(wxGetRootWindow()->window,
 296                                                   (gchar *) maskBits, w, h);
 297
 298     m_refData = new wxCursorRefData;
 299     M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixmap
 300                              (
 301                                 data,
 302                                 mask,
 303 #if GTK_CHECK_VERSION(2, 6, 0)
 304                                 fg.GetColor(), bg.GetColor(),
 305 #else
 306                                 wx_const_cast(GdkColor*, fg.GetColor()), wx_const_cast(GdkColor*, bg.GetColor()),
 307 #endif
 308                                 hotSpotX, hotSpotY
 309                              );
 310
 311     g_object_unref (data);
 312     g_object_unref (mask);
 313     delete [] bits;
 314     delete [] maskBits;
 315 }
 316
 317 #endif // wxUSE_IMAGE
 318
 319 wxCursor::~wxCursor()
 320 {
 321 }
 322
 323 bool wxCursor::operator == ( const wxCursor& cursor ) const
 324 {
 325     return m_refData == cursor.m_refData;
 326 }
 327
 328 bool wxCursor::operator != ( const wxCursor& cursor ) const
 329 {
 330     return m_refData != cursor.m_refData;
 331 }
 332
 333 bool wxCursor::Ok() const
 334 {
 335     return (m_refData != NULL);
 336 }
 337
 338 GdkCursor *wxCursor::GetCursor() const
 339 {
 340     return M_CURSORDATA->m_cursor;
 341 }
 342
 343 //-----------------------------------------------------------------------------
 344 // busy cursor routines
 345 //-----------------------------------------------------------------------------
 346
 347 extern wxCursor g_globalCursor;
 348
 349 static wxCursor  gs_savedCursor;
 350 static int       gs_busyCount = 0;
 351
 352 const wxCursor &wxBusyCursor::GetStoredCursor()
 353 {
 354     return gs_savedCursor;
 355 }
 356
 357 const wxCursor wxBusyCursor::GetBusyCursor()
 358 {
 359     return wxCursor(wxCURSOR_WATCH);
 360 }
 361
 362 void wxEndBusyCursor()
 363 {
 364     if (--gs_busyCount > 0)
 365         return;
 366
 367     wxSetCursor( gs_savedCursor );
 368     gs_savedCursor = wxNullCursor;
 369
 370     if (wxTheApp)
 371         wxTheApp->ProcessIdle();
 372 }
 373
 374 void wxBeginBusyCursor( const wxCursor *WXUNUSED(cursor) )
 375 {
 376     if (gs_busyCount++ > 0)
 377         return;
 378
 379     wxASSERT_MSG( !gs_savedCursor.Ok(),
 380                   wxT("forgot to call wxEndBusyCursor, will leak memory") );
 381
 382     gs_savedCursor = g_globalCursor;
 383
 384     wxSetCursor( wxCursor(wxCURSOR_WATCH) );
 385
 386     if (wxTheApp)
 387         wxTheApp->ProcessIdle();
 388
 389     gdk_flush();
 390 }
 391
 392 bool wxIsBusy()
 393 {
 394     return gs_busyCount > 0;
 395 }
 396
 397 void wxSetCursor( const wxCursor& cursor )
 398 {
 399     if (g_isIdle)
 400         wxapp_install_idle_handler();
 401
 402     g_globalCursor = cursor;
 403 }