src/msw/dragimag.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/dragimag.cpp
   3 // Purpose:     wxDragImage
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     08/04/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_DRAGIMAGE
  28
  29 #ifndef WX_PRECOMP
  30     #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
  31     #include <stdio.h>
  32     #include "wx/window.h"
  33     #include "wx/dcclient.h"
  34     #include "wx/dcscreen.h"
  35     #include "wx/dcmemory.h"
  36     #include "wx/settings.h"
  37     #include "wx/intl.h"
  38     #include "wx/log.h"
  39     #include "wx/frame.h"
  40     #include "wx/image.h"
  41 #endif
  42
  43 #include "wx/msw/private.h"
  44
  45 #include "wx/msw/dragimag.h"
  46 #include "wx/msw/private.h"
  47
  48 #ifdef __WXWINCE__  // for SM_CXCURSOR and SM_CYCURSOR
  49 #include "wx/msw/wince/missing.h"
  50 #endif // __WXWINCE__
  51
  52 // Wine doesn't have this yet
  53 #ifndef ListView_CreateDragImage
  54 #define ListView_CreateDragImage(hwnd, i, lpptUpLeft) \
  55     (HIMAGELIST)SNDMSG((hwnd), LVM_CREATEDRAGIMAGE, (WPARAM)(int)(i), (LPARAM)(LPPOINT)(lpptUpLeft))
  56 #endif
  57
  58 // ----------------------------------------------------------------------------
  59 // macros
  60 // ----------------------------------------------------------------------------
  61
  62 IMPLEMENT_DYNAMIC_CLASS(wxDragImage, wxObject)
  63
  64 #define GetHimageList() ((HIMAGELIST) m_hImageList)
  65
  66 // ============================================================================
  67 // implementation
  68 // ============================================================================
  69
  70 // ----------------------------------------------------------------------------
  71 // wxDragImage ctors/dtor
  72 // ----------------------------------------------------------------------------
  73
  74 wxDragImage::wxDragImage()
  75 {
  76     Init();
  77 }
  78
  79 wxDragImage::~wxDragImage()
  80 {
  81     if ( m_hImageList )
  82         ImageList_Destroy(GetHimageList());
  83 #if !wxUSE_SIMPLER_DRAGIMAGE
  84     if ( m_hCursorImageList )
  85         ImageList_Destroy((HIMAGELIST) m_hCursorImageList);
  86 #endif
  87 }
  88
  89 void wxDragImage::Init()
  90 {
  91     m_hImageList = 0;
  92 #if !wxUSE_SIMPLER_DRAGIMAGE
  93     m_hCursorImageList = 0;
  94 #endif
  95     m_window = NULL;
  96     m_fullScreen = false;
  97 }
  98
  99 // Attributes
 100 ////////////////////////////////////////////////////////////////////////////
 101
 102
 103 // Operations
 104 ////////////////////////////////////////////////////////////////////////////
 105
 106 // Create a drag image from a bitmap and optional cursor
 107 bool wxDragImage::Create(const wxBitmap& image, const wxCursor& cursor)
 108 {
 109     if ( m_hImageList )
 110         ImageList_Destroy(GetHimageList());
 111     m_hImageList = 0;
 112
 113 #ifdef __WXWINCE__
 114     UINT flags = ILC_COLOR;
 115 #else
 116     UINT flags wxDUMMY_INITIALIZE(0) ;
 117     if (image.GetDepth() <= 4)
 118         flags = ILC_COLOR4;
 119     else if (image.GetDepth() <= 8)
 120         flags = ILC_COLOR8;
 121     else if (image.GetDepth() <= 16)
 122         flags = ILC_COLOR16;
 123     else if (image.GetDepth() <= 24)
 124         flags = ILC_COLOR24;
 125     else
 126         flags = ILC_COLOR32;
 127 #endif
 128
 129     bool mask = (image.GetMask() != 0);
 130
 131     // Curiously, even if the image doesn't have a mask,
 132     // we still have to use ILC_MASK or the image won't show
 133     // up when dragged.
 134 //    if ( mask )
 135     flags |= ILC_MASK;
 136
 137     m_hImageList = (WXHIMAGELIST) ImageList_Create(image.GetWidth(), image.GetHeight(), flags, 1, 1);
 138
 139     int index;
 140     if (!mask)
 141     {
 142         HBITMAP hBitmap1 = (HBITMAP) image.GetHBITMAP();
 143         index = ImageList_Add(GetHimageList(), hBitmap1, 0);
 144     }
 145     else
 146     {
 147         HBITMAP hBitmap1 = (HBITMAP) image.GetHBITMAP();
 148         HBITMAP hBitmap2 = (HBITMAP) image.GetMask()->GetMaskBitmap();
 149         HBITMAP hbmpMask = wxInvertMask(hBitmap2);
 150
 151         index = ImageList_Add(GetHimageList(), hBitmap1, hbmpMask);
 152         ::DeleteObject(hbmpMask);
 153     }
 154     if ( index == -1 )
 155     {
 156         wxLogError(_("Couldn't add an image to the image list."));
 157     }
 158     m_cursor = cursor; // Can only combine with drag image after calling BeginDrag.
 159
 160     return (index != -1) ;
 161 }
 162
 163 // Create a drag image from an icon and optional cursor
 164 bool wxDragImage::Create(const wxIcon& image, const wxCursor& cursor)
 165 {
 166     if ( m_hImageList )
 167         ImageList_Destroy(GetHimageList());
 168     m_hImageList = 0;
 169
 170 #ifdef __WXWINCE__
 171     UINT flags = ILC_COLOR;
 172 #else
 173     UINT flags wxDUMMY_INITIALIZE(0) ;
 174     if (image.GetDepth() <= 4)
 175         flags = ILC_COLOR4;
 176     else if (image.GetDepth() <= 8)
 177         flags = ILC_COLOR8;
 178     else if (image.GetDepth() <= 16)
 179         flags = ILC_COLOR16;
 180     else if (image.GetDepth() <= 24)
 181         flags = ILC_COLOR24;
 182     else
 183         flags = ILC_COLOR32;
 184 #endif
 185
 186     flags |= ILC_MASK;
 187
 188     m_hImageList = (WXHIMAGELIST) ImageList_Create(image.GetWidth(), image.GetHeight(), flags, 1, 1);
 189
 190     HICON hIcon = (HICON) image.GetHICON();
 191
 192     int index = ImageList_AddIcon(GetHimageList(), hIcon);
 193     if ( index == -1 )
 194     {
 195         wxLogError(_("Couldn't add an image to the image list."));
 196     }
 197
 198     m_cursor = cursor; // Can only combine with drag image after calling BeginDrag.
 199
 200     return (index != -1) ;
 201 }
 202
 203 // Create a drag image from a string and optional cursor
 204 bool wxDragImage::Create(const wxString& str, const wxCursor& cursor)
 205 {
 206     wxFont font(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
 207
 208     wxCoord w = 0, h = 0;
 209     wxScreenDC dc;
 210     dc.SetFont(font);
 211     dc.GetTextExtent(str, & w, & h);
 212     dc.SetFont(wxNullFont);
 213
 214     wxMemoryDC dc2;
 215     dc2.SetFont(font);
 216     wxBitmap bitmap((int) w+2, (int) h+2);
 217     dc2.SelectObject(bitmap);
 218
 219     dc2.SetBackground(* wxWHITE_BRUSH);
 220     dc2.Clear();
 221     dc2.SetBackgroundMode(wxBRUSHSTYLE_TRANSPARENT);
 222     dc2.SetTextForeground(* wxLIGHT_GREY);
 223     dc2.DrawText(str, 0, 0);
 224     dc2.DrawText(str, 1, 0);
 225     dc2.DrawText(str, 2, 0);
 226     dc2.DrawText(str, 1, 1);
 227     dc2.DrawText(str, 2, 1);
 228     dc2.DrawText(str, 1, 2);
 229     dc2.DrawText(str, 2, 2);
 230     dc2.SetTextForeground(* wxBLACK);
 231     dc2.DrawText(str, 1, 1);
 232
 233     dc2.SelectObject(wxNullBitmap);
 234
 235 #if wxUSE_WXDIB
 236     // Make the bitmap masked
 237     wxImage image = bitmap.ConvertToImage();
 238     image.SetMaskColour(255, 255, 255);
 239     return Create(wxBitmap(image), cursor);
 240 #else
 241     return false;
 242 #endif
 243 }
 244
 245 #if wxUSE_TREECTRL
 246 // Create a drag image for the given tree control item
 247 bool wxDragImage::Create(const wxTreeCtrl& treeCtrl, wxTreeItemId& id)
 248 {
 249     if ( m_hImageList )
 250         ImageList_Destroy(GetHimageList());
 251     m_hImageList = (WXHIMAGELIST)
 252         TreeView_CreateDragImage(GetHwndOf(&treeCtrl), (HTREEITEM) id.m_pItem);
 253     if ( !m_hImageList )
 254     {
 255         // fall back on just the item text if there is no image
 256         return Create(treeCtrl.GetItemText(id));
 257     }
 258
 259     return true;
 260 }
 261 #endif
 262
 263 #if wxUSE_LISTCTRL
 264 // Create a drag image for the given list control item
 265 bool wxDragImage::Create(const wxListCtrl& listCtrl, long id)
 266 {
 267     if ( m_hImageList )
 268         ImageList_Destroy(GetHimageList());
 269     POINT pt;
 270     pt.x =
 271     pt.y = 0;
 272     m_hImageList = (WXHIMAGELIST)
 273         ListView_CreateDragImage(GetHwndOf(&listCtrl), id, &pt);
 274
 275     if ( !m_hImageList )
 276     {
 277         // as for wxTreeCtrl, fall back on dragging just the item text
 278         return Create(listCtrl.GetItemText(id));
 279     }
 280
 281     return true;
 282 }
 283 #endif
 284
 285 // Begin drag
 286 bool wxDragImage::BeginDrag(const wxPoint& hotspot, wxWindow* window, bool fullScreen, wxRect* rect)
 287 {
 288     wxASSERT_MSG( (m_hImageList != 0), wxT("Image list must not be null in BeginDrag."));
 289     wxASSERT_MSG( (window != 0), wxT("Window must not be null in BeginDrag."));
 290
 291     m_fullScreen = fullScreen;
 292     if (rect)
 293         m_boundingRect = * rect;
 294
 295     bool ret = (ImageList_BeginDrag(GetHimageList(), 0, hotspot.x, hotspot.y) != 0);
 296
 297     if (!ret)
 298     {
 299         wxFAIL_MSG( wxT("BeginDrag failed.") );
 300
 301         return false;
 302     }
 303
 304     if (m_cursor.IsOk())
 305     {
 306 #if wxUSE_SIMPLER_DRAGIMAGE
 307         m_oldCursor = window->GetCursor();
 308         window->SetCursor(m_cursor);
 309 #else
 310         if (!m_hCursorImageList)
 311         {
 312 #ifndef SM_CXCURSOR
 313             // Smartphone may not have these metric symbol
 314             int cxCursor = 16;
 315             int cyCursor = 16;
 316 #else
 317             int cxCursor = ::GetSystemMetrics(SM_CXCURSOR);
 318             int cyCursor = ::GetSystemMetrics(SM_CYCURSOR);
 319 #endif
 320             m_hCursorImageList = (WXHIMAGELIST) ImageList_Create(cxCursor, cyCursor, ILC_MASK, 1, 1);
 321         }
 322
 323         // See if we can find the cursor hotspot
 324         wxPoint curHotSpot(hotspot);
 325
 326         // Although it seems to produce the right position, when the hotspot goeos
 327         // negative it has strange effects on the image.
 328         // How do we stop the cursor jumping right and below of where it should be?
 329 #if 0
 330         ICONINFO iconInfo;
 331         if (::GetIconInfo((HICON) (HCURSOR) m_cursor.GetHCURSOR(), & iconInfo) != 0)
 332         {
 333             curHotSpot.x -= iconInfo.xHotspot;
 334             curHotSpot.y -= iconInfo.yHotspot;
 335         }
 336 #endif
 337         //wxString msg;
 338         //msg.Printf("Hotspot = %d, %d", curHotSpot.x, curHotSpot.y);
 339         //wxLogDebug(msg);
 340
 341         // First add the cursor to the image list
 342         HCURSOR hCursor = (HCURSOR) m_cursor.GetHCURSOR();
 343         int cursorIndex = ImageList_AddIcon((HIMAGELIST) m_hCursorImageList, (HICON) hCursor);
 344
 345         wxASSERT_MSG( (cursorIndex != -1), wxT("ImageList_AddIcon failed in BeginDrag."));
 346
 347         if (cursorIndex != -1)
 348         {
 349             ImageList_SetDragCursorImage((HIMAGELIST) m_hCursorImageList, cursorIndex, curHotSpot.x, curHotSpot.y);
 350         }
 351 #endif
 352     }
 353
 354 #if !wxUSE_SIMPLER_DRAGIMAGE
 355     if (m_cursor.IsOk())
 356         ::ShowCursor(FALSE);
 357 #endif
 358
 359     m_window = window;
 360
 361     ::SetCapture(GetHwndOf(window));
 362
 363     return true;
 364 }
 365
 366 // Begin drag. hotspot is the location of the drag position relative to the upper-left
 367 // corner of the image. This is full screen only. fullScreenRect gives the
 368 // position of the window on the screen, to restrict the drag to.
 369 bool wxDragImage::BeginDrag(const wxPoint& hotspot, wxWindow* window, wxWindow* fullScreenRect)
 370 {
 371     wxRect rect;
 372
 373     int x = fullScreenRect->GetPosition().x;
 374     int y = fullScreenRect->GetPosition().y;
 375
 376     wxSize sz = fullScreenRect->GetSize();
 377
 378     if (fullScreenRect->GetParent() && !fullScreenRect->IsKindOf(CLASSINFO(wxFrame)))
 379         fullScreenRect->GetParent()->ClientToScreen(& x, & y);
 380
 381     rect.x = x; rect.y = y;
 382     rect.width = sz.x; rect.height = sz.y;
 383
 384     return BeginDrag(hotspot, window, true, & rect);
 385 }
 386
 387 // End drag
 388 bool wxDragImage::EndDrag()
 389 {
 390     wxASSERT_MSG( (m_hImageList != 0), wxT("Image list must not be null in EndDrag."));
 391
 392     ImageList_EndDrag();
 393
 394     if ( !::ReleaseCapture() )
 395     {
 396         wxLogLastError(wxT("ReleaseCapture"));
 397     }
 398
 399 #if wxUSE_SIMPLER_DRAGIMAGE
 400     if (m_cursor.IsOk() && m_oldCursor.IsOk())
 401         m_window->SetCursor(m_oldCursor);
 402 #else
 403     ::ShowCursor(TRUE);
 404 #endif
 405
 406     m_window = NULL;
 407
 408     return true;
 409 }
 410
 411 // Move the image: call from OnMouseMove. Pt is in window client coordinates if window
 412 // is non-NULL, or in screen coordinates if NULL.
 413 bool wxDragImage::Move(const wxPoint& pt)
 414 {
 415     wxASSERT_MSG( (m_hImageList != 0), wxT("Image list must not be null in Move."));
 416
 417     // These are in window, not client coordinates.
 418     // So need to convert to client coordinates.
 419     wxPoint pt2(pt);
 420     if (m_window && !m_fullScreen)
 421     {
 422         RECT rect;
 423         rect.left = 0; rect.top = 0;
 424         rect.right = 0; rect.bottom = 0;
 425         DWORD style = ::GetWindowLong((HWND) m_window->GetHWND(), GWL_STYLE);
 426 #ifdef __WIN32__
 427         DWORD exStyle = ::GetWindowLong((HWND) m_window->GetHWND(), GWL_EXSTYLE);
 428         ::AdjustWindowRectEx(& rect, style, FALSE, exStyle);
 429 #else
 430         ::AdjustWindowRect(& rect, style, FALSE);
 431 #endif
 432         // Subtract the (negative) values, i.e. add a small increment
 433         pt2.x -= rect.left; pt2.y -= rect.top;
 434     }
 435     else if (m_window && m_fullScreen)
 436     {
 437         pt2 = m_window->ClientToScreen(pt2);
 438     }
 439
 440     bool ret = (ImageList_DragMove( pt2.x, pt2.y ) != 0);
 441
 442     m_position = pt2;
 443
 444     return ret;
 445 }
 446
 447 bool wxDragImage::Show()
 448 {
 449     wxASSERT_MSG( (m_hImageList != 0), wxT("Image list must not be null in Show."));
 450
 451     HWND hWnd = 0;
 452     if (m_window && !m_fullScreen)
 453         hWnd = (HWND) m_window->GetHWND();
 454
 455     bool ret = (ImageList_DragEnter( hWnd, m_position.x, m_position.y ) != 0);
 456
 457     return ret;
 458 }
 459
 460 bool wxDragImage::Hide()
 461 {
 462     wxASSERT_MSG( (m_hImageList != 0), wxT("Image list must not be null in Hide."));
 463
 464     HWND hWnd = 0;
 465     if (m_window && !m_fullScreen)
 466         hWnd = (HWND) m_window->GetHWND();
 467
 468     bool ret = (ImageList_DragLeave( hWnd ) != 0);
 469
 470     return ret;
 471 }
 472
 473 #endif // wxUSE_DRAGIMAGE