X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9e2896e5c8944c5f5227fa080e1b781c4a6f2600..526954c5968baa29218c994ec48e476ae2bd4b9f:/src/msw/ole/droptgt.cpp diff --git a/src/msw/ole/droptgt.cpp b/src/msw/ole/droptgt.cpp index c9f5feb506..e63e55038e 100644 --- a/src/msw/ole/droptgt.cpp +++ b/src/msw/ole/droptgt.cpp @@ -1,12 +1,12 @@ /////////////////////////////////////////////////////////////////////////////// -// Name: ole/droptgt.cpp +// Name: src/msw/ole/droptgt.cpp // Purpose: wxDropTarget implementation // Author: Vadim Zeitlin // Modified by: // Created: // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin -// Licence: wxWindows license +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -17,25 +17,29 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ -#pragma implementation "droptgt.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #if defined(__BORLANDC__) -#pragma hdrstop + #pragma hdrstop #endif -#include "wx/setup.h" +#if wxUSE_OLE && wxUSE_DRAG_AND_DROP -#if wxUSE_DRAG_AND_DROP +#ifndef WX_PRECOMP + #include "wx/msw/wrapwin.h" + #include "wx/log.h" +#endif -#include "wx/log.h" +#include "wx/msw/private.h" + +#ifdef __WXWINCE__ + #include + #include +#endif #ifdef __WIN32__ - #ifndef __GNUWIN32__ + #if !defined(__GNUWIN32__) || wxUSE_NORLANDER_HEADERS #include // for DROPFILES structure #endif #else @@ -44,11 +48,6 @@ #include "wx/dnd.h" -#ifndef __WIN32__ - #include - #include -#endif - #include "wx/msw/ole/oleutils.h" // ---------------------------------------------------------------------------- @@ -60,45 +59,83 @@ class wxIDropTarget : public IDropTarget { public: - wxIDropTarget(wxDropTarget *p); - ~wxIDropTarget(); + wxIDropTarget(wxDropTarget *p); + virtual ~wxIDropTarget(); - // IDropTarget methods - STDMETHODIMP DragEnter(LPDATAOBJECT, DWORD, POINTL, LPDWORD); - STDMETHODIMP DragOver(DWORD, POINTL, LPDWORD); - STDMETHODIMP DragLeave(void); - STDMETHODIMP Drop(LPDATAOBJECT, DWORD, POINTL, LPDWORD); + // accessors for wxDropTarget + void SetHwnd(HWND hwnd) { m_hwnd = hwnd; } - DECLARE_IUNKNOWN_METHODS; + // IDropTarget methods + STDMETHODIMP DragEnter(LPDATAOBJECT, DWORD, POINTL, LPDWORD); + STDMETHODIMP DragOver(DWORD, POINTL, LPDWORD); + STDMETHODIMP DragLeave(); + STDMETHODIMP Drop(LPDATAOBJECT, DWORD, POINTL, LPDWORD); + + DECLARE_IUNKNOWN_METHODS; protected: - IDataObject *m_pIDataObject; // !NULL between DragEnter and DragLeave/Drop - wxDropTarget *m_pTarget; // the real target (we're just a proxy) + IDataObject *m_pIDataObject; // !NULL between DragEnter and DragLeave/Drop + wxDropTarget *m_pTarget; // the real target (we're just a proxy) + + HWND m_hwnd; // window we're associated with + + // get default drop effect for given keyboard flags + static DWORD GetDropEffect(DWORD flags, wxDragResult defaultAction, DWORD pdwEffect); -private: - static inline DWORD GetDropEffect(DWORD flags); + wxDECLARE_NO_COPY_CLASS(wxIDropTarget); }; +// ---------------------------------------------------------------------------- +// private functions +// ---------------------------------------------------------------------------- + +static wxDragResult ConvertDragEffectToResult(DWORD dwEffect); +static DWORD ConvertDragResultToEffect(wxDragResult result); + // ============================================================================ // wxIDropTarget implementation // ============================================================================ -// Name : static wxDropTarget::GetDropEffect +// Name : static wxIDropTarget::GetDropEffect // Purpose : determine the drop operation from keyboard/mouse state. // Returns : DWORD combined from DROPEFFECT_xxx constants -// Params : [in] DWORD flags kbd & mouse flags as passed to -// IDropTarget methods +// Params : [in] DWORD flags kbd & mouse flags as passed to +// IDropTarget methods +// [in] wxDragResult defaultAction the default action of the drop target +// [in] DWORD pdwEffect the supported actions of the drop +// source passed to IDropTarget methods // Notes : We do "move" normally and "copy" if is pressed, // which is the standard behaviour (currently there is no // way to redefine it) -DWORD wxIDropTarget::GetDropEffect(DWORD flags) +DWORD wxIDropTarget::GetDropEffect(DWORD flags, + wxDragResult defaultAction, + DWORD pdwEffect) { - return flags & MK_CONTROL ? DROPEFFECT_COPY : DROPEFFECT_MOVE; + DWORD effectiveAction; + if ( defaultAction == wxDragCopy ) + effectiveAction = flags & MK_SHIFT ? DROPEFFECT_MOVE : DROPEFFECT_COPY; + else + effectiveAction = flags & MK_CONTROL ? DROPEFFECT_COPY : DROPEFFECT_MOVE; + + if ( !(effectiveAction & pdwEffect) ) + { + // the action is not supported by drag source, fall back to something + // that it does support + if ( pdwEffect & DROPEFFECT_MOVE ) + effectiveAction = DROPEFFECT_MOVE; + else if ( pdwEffect & DROPEFFECT_COPY ) + effectiveAction = DROPEFFECT_COPY; + else if ( pdwEffect & DROPEFFECT_LINK ) + effectiveAction = DROPEFFECT_LINK; + else + effectiveAction = DROPEFFECT_NONE; + } + + return effectiveAction; } wxIDropTarget::wxIDropTarget(wxDropTarget *pTarget) { - m_cRef = 0; m_pTarget = pTarget; m_pIDataObject = NULL; } @@ -117,59 +154,115 @@ IMPLEMENT_IUNKNOWN_METHODS(wxIDropTarget) // Name : wxIDropTarget::DragEnter // Purpose : Called when the mouse enters the window (dragging something) // Returns : S_OK -// Params : [in] IDataObject *pIDataSource : source data -// [in] DWORD grfKeyState : kbd & mouse state -// [in] POINTL pt : mouse coordinates -// [out]DWORD *pdwEffect : effect flag +// Params : [in] IDataObject *pIDataSource : source data +// [in] DWORD grfKeyState : kbd & mouse state +// [in] POINTL pt : mouse coordinates +// [in/out]DWORD *pdwEffect : effect flag +// In: Supported effects +// Out: Resulting effect // Notes : STDMETHODIMP wxIDropTarget::DragEnter(IDataObject *pIDataSource, DWORD grfKeyState, POINTL pt, DWORD *pdwEffect) { - wxLogDebug(wxT("IDropTarget::DragEnter")); + wxLogTrace(wxTRACE_OleCalls, wxT("IDropTarget::DragEnter")); + + wxASSERT_MSG( m_pIDataObject == NULL, + wxT("drop target must have data object") ); + + // show the list of formats supported by the source data object for the + // debugging purposes, this is quite useful sometimes - please don't remove +#if 0 + IEnumFORMATETC *penumFmt; + if ( SUCCEEDED(pIDataSource->EnumFormatEtc(DATADIR_GET, &penumFmt)) ) + { + FORMATETC fmt; + while ( penumFmt->Next(1, &fmt, NULL) == S_OK ) + { + wxLogDebug(wxT("Drop source supports format %s"), + wxDataObject::GetFormatName(fmt.cfFormat)); + } - wxASSERT( m_pIDataObject == NULL ); + penumFmt->Release(); + } + else + { + wxLogLastError(wxT("IDataObject::EnumFormatEtc")); + } +#endif // 0 - if ( !m_pTarget->IsAcceptedData(pIDataSource) ) { - // we don't accept this kind of data - *pdwEffect = DROPEFFECT_NONE; + if ( !m_pTarget->MSWIsAcceptedData(pIDataSource) ) { + // we don't accept this kind of data + *pdwEffect = DROPEFFECT_NONE; - return S_OK; - } + return S_OK; + } - // TODO should check the point also? + // for use in OnEnter and OnDrag calls + m_pTarget->MSWSetDataSource(pIDataSource); - *pdwEffect = GetDropEffect(grfKeyState); + // get hold of the data object + m_pIDataObject = pIDataSource; + m_pIDataObject->AddRef(); - // get hold of the data object - m_pIDataObject = pIDataSource; - m_pIDataObject->AddRef(); + // we need client coordinates to pass to wxWin functions + if ( !ScreenToClient(m_hwnd, (POINT *)&pt) ) + { + wxLogLastError(wxT("ScreenToClient")); + } - // give some visual feedback - m_pTarget->OnEnter(); + // give some visual feedback + *pdwEffect = ConvertDragResultToEffect( + m_pTarget->OnEnter(pt.x, pt.y, ConvertDragEffectToResult( + GetDropEffect(grfKeyState, m_pTarget->GetDefaultAction(), *pdwEffect)) + ) + ); - return S_OK; + return S_OK; } // Name : wxIDropTarget::DragOver // Purpose : Indicates that the mouse was moved inside the window represented // by this drop target. // Returns : S_OK -// Params : [in] DWORD grfKeyState kbd & mouse state -// [in] POINTL pt mouse coordinates -// [out]LPDWORD pdwEffect effect flag +// Params : [in] DWORD grfKeyState kbd & mouse state +// [in] POINTL pt mouse coordinates +// [in/out]LPDWORD pdwEffect current effect flag // Notes : We're called on every WM_MOUSEMOVE, so this function should be // very efficient. STDMETHODIMP wxIDropTarget::DragOver(DWORD grfKeyState, POINTL pt, LPDWORD pdwEffect) { - // there are too many of them... wxLogDebug("IDropTarget::DragOver"); + // there are too many of them... wxLogDebug("IDropTarget::DragOver"); - *pdwEffect = m_pIDataObject == NULL ? DROPEFFECT_NONE - : GetDropEffect(grfKeyState); - return S_OK; + wxDragResult result; + if ( m_pIDataObject ) { + result = ConvertDragEffectToResult( + GetDropEffect(grfKeyState, m_pTarget->GetDefaultAction(), *pdwEffect)); + } + else { + // can't accept data anyhow normally + result = wxDragNone; + } + + if ( result != wxDragNone ) { + // we need client coordinates to pass to wxWin functions + if ( !ScreenToClient(m_hwnd, (POINT *)&pt) ) + { + wxLogLastError(wxT("ScreenToClient")); + } + + *pdwEffect = ConvertDragResultToEffect( + m_pTarget->OnDragOver(pt.x, pt.y, result) + ); + } + else { + *pdwEffect = DROPEFFECT_NONE; + } + + return S_OK; } // Name : wxIDropTarget::DragLeave @@ -178,7 +271,7 @@ STDMETHODIMP wxIDropTarget::DragOver(DWORD grfKeyState, // Notes : good place to do any clean-up STDMETHODIMP wxIDropTarget::DragLeave() { - wxLogDebug(wxT("IDropTarget::DragLeave")); + wxLogTrace(wxTRACE_OleCalls, wxT("IDropTarget::DragLeave")); // remove the UI feedback m_pTarget->OnLeave(); @@ -193,38 +286,49 @@ STDMETHODIMP wxIDropTarget::DragLeave() // Purpose : Instructs the drop target to paste data that was just now // dropped on it. // Returns : S_OK -// Params : [in] IDataObject *pIDataSource the data to paste -// [in] DWORD grfKeyState kbd & mouse state -// [in] POINTL pt where the drop occured? -// [ouy]DWORD *pdwEffect operation effect +// Params : [in] IDataObject *pIDataSource the data to paste +// [in] DWORD grfKeyState kbd & mouse state +// [in] POINTL pt where the drop occurred? +// [in/out]DWORD *pdwEffect operation effect // Notes : STDMETHODIMP wxIDropTarget::Drop(IDataObject *pIDataSource, DWORD grfKeyState, POINTL pt, DWORD *pdwEffect) { - wxLogDebug(wxT("IDropTarget::Drop")); + wxLogTrace(wxTRACE_OleCalls, wxT("IDropTarget::Drop")); // TODO I don't know why there is this parameter, but so far I assume // that it's the same we've already got in DragEnter wxASSERT( m_pIDataObject == pIDataSource ); - // by default, nothing happens - *pdwEffect = DROPEFFECT_NONE; + // we need client coordinates to pass to wxWin functions + if ( !ScreenToClient(m_hwnd, (POINT *)&pt) ) + { + wxLogLastError(wxT("ScreenToClient")); + } // first ask the drop target if it wants data if ( m_pTarget->OnDrop(pt.x, pt.y) ) { // it does, so give it the data source - m_pTarget->SetDataSource(pIDataSource); + m_pTarget->MSWSetDataSource(pIDataSource); // and now it has the data - if ( m_pTarget->OnData(pt.x, pt.y) ) { + wxDragResult rc = ConvertDragEffectToResult( + GetDropEffect(grfKeyState, m_pTarget->GetDefaultAction(), *pdwEffect)); + rc = m_pTarget->OnData(pt.x, pt.y, rc); + if ( wxIsDragResultOk(rc) ) { // operation succeeded - *pdwEffect = GetDropEffect(grfKeyState); + *pdwEffect = ConvertDragResultToEffect(rc); } - //else: *pdwEffect is already DROPEFFECT_NONE + else { + *pdwEffect = DROPEFFECT_NONE; + } + } + else { + // OnDrop() returned false, no need to copy data + *pdwEffect = DROPEFFECT_NONE; } - //else: OnDrop() returned FALSE, no need to copy data // release the held object RELEASE_AND_NULL(m_pIDataObject); @@ -260,54 +364,83 @@ wxDropTarget::~wxDropTarget() bool wxDropTarget::Register(WXHWND hwnd) { - HRESULT hr = ::CoLockObjectExternal(m_pIDropTarget, TRUE, FALSE); + // FIXME + // RegisterDragDrop not available on Windows CE >= 400? + // Or maybe we can dynamically load them from ceshell.dll + // or similar. +#if defined(__WXWINCE__) && _WIN32_WCE >= 400 + wxUnusedVar(hwnd); + return false; +#else + HRESULT hr; + + // May exist in later WinCE versions +#ifndef __WXWINCE__ + hr = ::CoLockObjectExternal(m_pIDropTarget, TRUE, FALSE); if ( FAILED(hr) ) { - wxLogApiError("CoLockObjectExternal", hr); - return FALSE; + wxLogApiError(wxT("CoLockObjectExternal"), hr); + return false; } +#endif hr = ::RegisterDragDrop((HWND) hwnd, m_pIDropTarget); if ( FAILED(hr) ) { + // May exist in later WinCE versions +#ifndef __WXWINCE__ ::CoLockObjectExternal(m_pIDropTarget, FALSE, FALSE); - - wxLogApiError("RegisterDragDrop", hr); - return FALSE; +#endif + wxLogApiError(wxT("RegisterDragDrop"), hr); + return false; } - return TRUE; + // we will need the window handle for coords transformation later + m_pIDropTarget->SetHwnd((HWND)hwnd); + + return true; +#endif } void wxDropTarget::Revoke(WXHWND hwnd) { +#if defined(__WXWINCE__) && _WIN32_WCE >= 400 + // Not available, see note above + wxUnusedVar(hwnd); +#else HRESULT hr = ::RevokeDragDrop((HWND) hwnd); if ( FAILED(hr) ) { - wxLogApiError("RevokeDragDrop", hr); + wxLogApiError(wxT("RevokeDragDrop"), hr); } + // May exist in later WinCE versions +#ifndef __WXWINCE__ ::CoLockObjectExternal(m_pIDropTarget, FALSE, TRUE); +#endif + + m_pIDropTarget->SetHwnd(0); +#endif } // ---------------------------------------------------------------------------- // base class pure virtuals // ---------------------------------------------------------------------------- -// OnDrop() is called only if we previously returned TRUE from +// OnDrop() is called only if we previously returned true from // IsAcceptedData(), so no need to check anything here bool wxDropTarget::OnDrop(wxCoord WXUNUSED(x), wxCoord WXUNUSED(y)) { - return TRUE; + return true; } // copy the data from the data source to the target data object bool wxDropTarget::GetData() { - wxDataFormat format = GetSupportedFormat(m_pIDataSource); + wxDataFormat format = MSWGetSupportedFormat(m_pIDataSource); if ( format == wxDF_INVALID ) { // this is strange because IsAcceptedData() succeeded previously! wxFAIL_MSG(wxT("strange - did supported formats list change?")); - return FALSE; + return false; } STGMEDIUM stm; @@ -318,7 +451,7 @@ bool wxDropTarget::GetData() fmtMemory.lindex = -1; fmtMemory.tymed = TYMED_HGLOBAL; // TODO to add other media - bool rc = FALSE; + bool rc = false; HRESULT hr = m_pIDataSource->GetData(&fmtMemory, &stm); if ( SUCCEEDED(hr) ) { @@ -326,14 +459,14 @@ bool wxDropTarget::GetData() hr = dataObject->SetData(&fmtMemory, &stm, TRUE); if ( SUCCEEDED(hr) ) { - rc = TRUE; + rc = true; } else { - wxLogLastError("IDataObject::SetData()"); + wxLogApiError(wxT("IDataObject::SetData()"), hr); } } else { - wxLogLastError("IDataObject::GetData()"); + wxLogApiError(wxT("IDataObject::GetData()"), hr); } return rc; @@ -344,22 +477,27 @@ bool wxDropTarget::GetData() // ---------------------------------------------------------------------------- // we need a data source, so wxIDropTarget gives it to us using this function -void wxDropTarget::SetDataSource(IDataObject *pIDataSource) +void wxDropTarget::MSWSetDataSource(IDataObject *pIDataSource) { m_pIDataSource = pIDataSource; } // determine if we accept data of this type -bool wxDropTarget::IsAcceptedData(IDataObject *pIDataSource) const +bool wxDropTarget::MSWIsAcceptedData(IDataObject *pIDataSource) const { - return GetSupportedFormat(pIDataSource) != wxDF_INVALID; + return MSWGetSupportedFormat(pIDataSource) != wxDF_INVALID; } // ---------------------------------------------------------------------------- // helper functions // ---------------------------------------------------------------------------- -wxDataFormat wxDropTarget::GetSupportedFormat(IDataObject *pIDataSource) const +wxDataFormat wxDropTarget::GetMatchingPair() +{ + return MSWGetSupportedFormat( m_pIDataSource ); +} + +wxDataFormat wxDropTarget::MSWGetSupportedFormat(IDataObject *pIDataSource) const { // this strucutre describes a data of any type (first field will be // changing) being passed through global memory block. @@ -373,7 +511,8 @@ wxDataFormat wxDropTarget::GetSupportedFormat(IDataObject *pIDataSource) const // get the list of supported formats size_t nFormats = m_dataObject->GetFormatCount(wxDataObject::Set); - wxDataFormat format, *formats; + wxDataFormat format; + wxDataFormat *formats; formats = nFormats == 1 ? &format : new wxDataFormat[nFormats]; m_dataObject->GetAllFormats(formats, wxDataObject::Set); @@ -397,43 +536,53 @@ wxDataFormat wxDropTarget::GetSupportedFormat(IDataObject *pIDataSource) const delete [] formats; } - return n < nFormats ? format : wxDF_INVALID; + return n < nFormats ? format : wxFormatInvalid; } // ---------------------------------------------------------------------------- -// wxTextDropTarget +// private functions // ---------------------------------------------------------------------------- -wxTextDropTarget::wxTextDropTarget() - : wxDropTarget(new wxTextDataObject) +static wxDragResult ConvertDragEffectToResult(DWORD dwEffect) { -} + switch ( dwEffect ) { + case DROPEFFECT_COPY: + return wxDragCopy; -bool wxTextDropTarget::OnData(wxCoord x, wxCoord y) -{ - if ( !GetData() ) - return FALSE; + case DROPEFFECT_LINK: + return wxDragLink; - return OnDropText(x, y, ((wxTextDataObject *)m_dataObject)->GetText()); -} + case DROPEFFECT_MOVE: + return wxDragMove; -// ---------------------------------------------------------------------------- -// wxFileDropTarget -// ---------------------------------------------------------------------------- + default: + wxFAIL_MSG(wxT("invalid value in ConvertDragEffectToResult")); + // fall through -wxFileDropTarget::wxFileDropTarget() - : wxDropTarget(new wxFileDataObject) -{ + case DROPEFFECT_NONE: + return wxDragNone; + } } -bool wxFileDropTarget::OnData(wxCoord x, wxCoord y) +static DWORD ConvertDragResultToEffect(wxDragResult result) { - if ( !GetData() ) - return FALSE; + switch ( result ) { + case wxDragCopy: + return DROPEFFECT_COPY; + + case wxDragLink: + return DROPEFFECT_LINK; - return OnDropFiles(x, y, - ((wxFileDataObject *)m_dataObject)->GetFilenames()); + case wxDragMove: + return DROPEFFECT_MOVE; + + default: + wxFAIL_MSG(wxT("invalid value in ConvertDragResultToEffect")); + // fall through + + case wxDragNone: + return DROPEFFECT_NONE; + } } -#endif - // wxUSE_DRAG_AND_DROP +#endif // wxUSE_OLE && wxUSE_DRAG_AND_DROP