src/gtk1/cursor.cpp

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