src/msw/dragimag.cpp

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