Click here to Skip to main content
Click here to Skip to main content

DragSourceHelper MFC

, 19 Jan 2003
Rate this:
Please Sign up or sign in to vote.
Making use of the IDragSourceHelper interface with MFC
<!-- Article image -->

Sample Image - DropSourceHelperMFC.jpg

<!-- Add the rest of your HTML here -->

Introduction

Beginning with Window2000 the shell exposes helper COM-objects that allow an application to specify an image that is displayed during a drag&drop operation. This image will automatically be alpha-blended to fit the current OS's look&feel. That's great news for a developer. The bad news is that it does not work with MFC's default implementation of the OLE data source without modification.

Background

The shell (version 5 or higher) exposes the DragSourceHelper object

(CLSID_DragDropHelper) with the interface IDragSourceHelper.

HRESULT InitializeFromBitmap(      
  LPSHDRAGIMAGE pshdi,
  IDataObject *pDataObject
);
HRESULT InitializeFromWindow(      
  HWND hwnd,
  POINT *ppt,
  IDataObject *pDataObject
);

The purpose of the object is to give visual feedback during a drag&drop operation. Before issuing the ::DoDragDrop call, you need to instantiate the object and transfer the bitmap you would like to see while the object is dragged around. That's all. In MFC that procedure reads like this:

The Data Source

Instantiate and initialize the data source:

COleDataSource source;
   // add some content to the source

The Helper Object

Instantiate the helper object using standard COM techniques. Obtain a bitmap handle and initialize the SHDRAGIMAGE structure. Now initialize the helper with the bitmap and the data object. Please note that this code also works under systems that do not expose the helper object (Windows 95,98,ME and NT), it simply does not display a drag image.

CComPtr<IDragSourceHelper> pHelper;
HRESULT hr = CoCreateInstance(CLSID_DragDropHelper,NULL,
  CLSCTX_ALL,IID_IDragSourceHelper,(LPVOID*)&pHelper);
if SUCCEEDED(hr) {
  // load a testbitmap
  CBitmap bmp;
  GetBitmap(bmp);
  // prepare the SHDRAGIMAGE structure
  BITMAP bmpInfo;
  bmp.GetBitmap(&bmpInfo);
  // fill the drag&drop structure  
  SHDRAGIMAGE info;
  info.sizeDragImage.cx = bmpInfo.bmWidth;
  info.sizeDragImage.cy = bmpInfo.bmHeight;
  info.ptOffset.x = 0;
  info.ptOffset.y = 0;
  info.hbmpDragImage = (HBITMAP)bmp.Detach();
  info.crColorKey = GetSysColor(COLOR_WINDOW);
  // this call assures that the bitmap will be dragged around
  hr = pHelper->InitializeFromBitmap(
    // drag&drop settings
    &info,
    // a pointer to the data object, the helper will store 
    // a reference to itself into this object
    (IDataObject*)source.GetInterface(&IID_IDataObject)
  );
  // in case of an error we need to destroy the image, 
  // else the helper object takes ownership
  if FAILED(hr)
    DeleteObject(info.hbmpDragImage);
}

Starting the Drag&Drop operation

Perform standard drag&drop.
source.DoDragDrop();

The Problem

Unfortunately this piece of code does not work because of a limitation of COleDataSource's implementation of the IDataObject interface. The reason is that in the call to InitializeFromBitmap the helper calls IDataObject::SetData with a custom clipboard format to keep a pointer to itself within the data object. The data object must satisfy this call. The default implementation of COleDataSource however does not accept unknown clipboard formats, so we need to override the IDataObject::SetData method.

The Solution

If we override the IDataObject::SetData method and allow an arbitrary format to be stored in the data object, everything works fine.
Class COleDataSourceEx : public COleDataSource
{
public:
  // helper methods to fix IDropSourceHelper
  DECLARE_INTERFACE_MAP()
  // handle name events
  BEGIN_INTERFACE_PART(DataObj, IDataObject)
    INIT_INTERFACE_PART(COleDataSourceEx, DataObject)
    // IDataObject
    …
    STDMETHOD(SetData)(LPFORMATETC, LPSTGMEDIUM, BOOL);
  END_INTERFACE_PART(DataObj)
};
STDMETHODIMP COleDataSourceEx::XDataObj::SetData(LPFORMATETC pFormatetc, 
    LPSTGMEDIUM pmedium, BOOL fRelease)
{
  METHOD_PROLOGUE(COleDataSourceEx, DataObj)
  // normal processing
  HRESULT hr = pThis->m_xDataObject.SetData(pFormatetc,pmedium,fRelease);
  if (hr==DATA_E_FORMATETC) {
    // cache the data explicitly
    pThis->CacheData(pFormatetc->cfFormat,pmedium,pFormatetc);
    return S_OK;
  }
  // normal error
  return hr;
}

Conclusion

The Windows2000 DragSourceHelper object provides a cool way to do alpha blended drag&drop with only very few lines of code.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

About the Author

Carsten Leue
Web Developer
Germany Germany
No Biography provided

Comments and Discussions

 
GeneralDrag Image Temporarily Disappears Over Some Windows PinmemberRaptorikus20-Jul-07 12:25 
QuestionDrop Destinations Infos? Pinmembervertex_x1-Dec-06 3:13 
GeneralImage question PinmemberTamás Károly6-Sep-05 22:26 
GeneralRe: Image question Pinmemberserhio1-Dec-05 8:04 
GeneralGood! Pinmemberdhatqd30-Mar-05 15:01 
GeneralA couple of points PinmemberHandyman11-Jun-03 21:35 
GeneralRe: A couple of points PinmemberCarsten Leue14-Jun-03 3:39 
Generalerror C2065: 'IDragSourceHelper' : undeclared identifier PinmemberAnthony_Yio24-Feb-03 23:29 
GeneralRe: error C2065: 'IDragSourceHelper' : undeclared identifier PinmemberCarsten Leue28-Feb-03 4:46 
In this case you need to get a newer SDK:
http://www.microsoft.com/msdownload/platformsdk/sdkupdate/
GeneralRe: error C2065: 'IDragSourceHelper' : undeclared identifier Pinmembervinsonhsieh9-Jan-05 21:48 
GeneralGood Job, but help me.... Pinmemberjedyking22-Jan-03 6:49 
GeneralRe: Good Job, but help me.... PinmemberCarsten Leue22-Jan-03 11:04 
GeneralHaven't you thougnt in make a one for the Win9X PinmemberCosmoS2k20-Jan-03 18:57 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web01 | 2.8.140718.1 | Last Updated 20 Jan 2003
Article Copyright 2003 by Carsten Leue
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid