]> git.saurik.com Git - wxWidgets.git/blame_incremental - src/msw/ole/dataobj.cpp
Committing in .
[wxWidgets.git] / src / msw / ole / dataobj.cpp
... / ...
CommitLineData
1///////////////////////////////////////////////////////////////////////////////
2// Name: msw/ole/dataobj.cpp
3// Purpose: implementation of wx[I]DataObject class
4// Author: Vadim Zeitlin
5// Modified by:
6// Created: 10.05.98
7// RCS-ID: $Id$
8// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9// Licence: wxWindows license
10///////////////////////////////////////////////////////////////////////////////
11
12// ============================================================================
13// declarations
14// ============================================================================
15
16// ----------------------------------------------------------------------------
17// headers
18// ----------------------------------------------------------------------------
19
20#ifdef __GNUG__
21 #pragma implementation "dataobj.h"
22#endif
23
24// For compilers that support precompilation, includes "wx.h".
25#include "wx/wxprec.h"
26
27#if defined(__BORLANDC__)
28 #pragma hdrstop
29#endif
30
31#if defined(__WIN32__) && !defined(__GNUWIN32_OLD__)
32
33#ifndef WX_PRECOMP
34 #include "wx/intl.h"
35 #include "wx/log.h"
36#endif
37
38#include "wx/dataobj.h"
39
40#include "wx/msw/private.h" // includes <windows.h>
41
42#ifdef wxUSE_NORLANDER_HEADERS
43 #include <ole2.h>
44#endif
45#include <oleauto.h>
46
47#ifndef __WIN32__
48 #include <ole2.h>
49 #include <olestd.h>
50#endif
51
52#include <shlobj.h>
53
54#include "wx/msw/ole/oleutils.h"
55
56#include "wx/msw/dib.h"
57
58// ----------------------------------------------------------------------------
59// functions
60// ----------------------------------------------------------------------------
61
62#ifdef __WXDEBUG__
63 static const wxChar *GetTymedName(DWORD tymed);
64#else // !Debug
65 #define GetTymedName(tymed) ""
66#endif // Debug/!Debug
67
68// ----------------------------------------------------------------------------
69// wxIEnumFORMATETC interface implementation
70// ----------------------------------------------------------------------------
71
72class wxIEnumFORMATETC : public IEnumFORMATETC
73{
74public:
75 wxIEnumFORMATETC(const wxDataFormat* formats, ULONG nCount);
76
77 // to suppress the gcc warning about "class has virtual functions but non
78 // virtual dtor"
79#ifdef __GNUG__
80 virtual
81#endif
82 ~wxIEnumFORMATETC() { delete [] m_formats; }
83
84 DECLARE_IUNKNOWN_METHODS;
85
86 // IEnumFORMATETC
87 STDMETHODIMP Next(ULONG celt, FORMATETC *rgelt, ULONG *pceltFetched);
88 STDMETHODIMP Skip(ULONG celt);
89 STDMETHODIMP Reset();
90 STDMETHODIMP Clone(IEnumFORMATETC **ppenum);
91
92private:
93 CLIPFORMAT *m_formats; // formats we can provide data in
94 ULONG m_nCount, // number of formats we support
95 m_nCurrent; // current enum position
96};
97
98// ----------------------------------------------------------------------------
99// wxIDataObject implementation of IDataObject interface
100// ----------------------------------------------------------------------------
101
102class wxIDataObject : public IDataObject
103{
104public:
105 wxIDataObject(wxDataObject *pDataObject);
106
107 // to suppress the gcc warning about "class has virtual functions but non
108 // virtual dtor"
109#ifdef __GNUG__
110 virtual
111#endif
112 ~wxIDataObject();
113
114 // normally, wxDataObject controls our lifetime (i.e. we're deleted when it
115 // is), but in some cases, the situation is inversed, that is we delete it
116 // when this object is deleted - setting this flag enables such logic
117 void SetDeleteFlag() { m_mustDelete = TRUE; }
118
119 DECLARE_IUNKNOWN_METHODS;
120
121 // IDataObject
122 STDMETHODIMP GetData(FORMATETC *pformatetcIn, STGMEDIUM *pmedium);
123 STDMETHODIMP GetDataHere(FORMATETC *pformatetc, STGMEDIUM *pmedium);
124 STDMETHODIMP QueryGetData(FORMATETC *pformatetc);
125 STDMETHODIMP GetCanonicalFormatEtc(FORMATETC *In, FORMATETC *pOut);
126 STDMETHODIMP SetData(FORMATETC *pfetc, STGMEDIUM *pmedium, BOOL fRelease);
127 STDMETHODIMP EnumFormatEtc(DWORD dwDirection, IEnumFORMATETC **ppenumFEtc);
128 STDMETHODIMP DAdvise(FORMATETC *pfetc, DWORD ad, IAdviseSink *p, DWORD *pdw);
129 STDMETHODIMP DUnadvise(DWORD dwConnection);
130 STDMETHODIMP EnumDAdvise(IEnumSTATDATA **ppenumAdvise);
131
132private:
133 wxDataObject *m_pDataObject; // pointer to C++ class we belong to
134
135 bool m_mustDelete;
136};
137
138// ============================================================================
139// implementation
140// ============================================================================
141
142// ----------------------------------------------------------------------------
143// wxDataFormat
144// ----------------------------------------------------------------------------
145
146void wxDataFormat::SetId(const wxChar *format)
147{
148 m_format = ::RegisterClipboardFormat(format);
149 if ( !m_format )
150 {
151 wxLogError(_("Couldn't register clipboard format '%s'."), format);
152 }
153}
154
155wxString wxDataFormat::GetId() const
156{
157 static const int max = 256;
158
159 wxString s;
160
161 wxCHECK_MSG( !IsStandard(), s,
162 wxT("name of predefined format cannot be retrieved") );
163
164 int len = ::GetClipboardFormatName(m_format, s.GetWriteBuf(max), max);
165 s.UngetWriteBuf();
166
167 if ( !len )
168 {
169 wxLogError(_("The clipboard format '%d' doesn't exist."), m_format);
170 }
171
172 return s;
173}
174
175// ----------------------------------------------------------------------------
176// wxIEnumFORMATETC
177// ----------------------------------------------------------------------------
178
179BEGIN_IID_TABLE(wxIEnumFORMATETC)
180 ADD_IID(Unknown)
181 ADD_IID(EnumFORMATETC)
182END_IID_TABLE;
183
184IMPLEMENT_IUNKNOWN_METHODS(wxIEnumFORMATETC)
185
186wxIEnumFORMATETC::wxIEnumFORMATETC(const wxDataFormat *formats, ULONG nCount)
187{
188 m_cRef = 0;
189 m_nCurrent = 0;
190 m_nCount = nCount;
191 m_formats = new CLIPFORMAT[nCount];
192 for ( ULONG n = 0; n < nCount; n++ ) {
193 m_formats[n] = formats[n].GetFormatId();
194 }
195}
196
197STDMETHODIMP wxIEnumFORMATETC::Next(ULONG celt,
198 FORMATETC *rgelt,
199 ULONG *pceltFetched)
200{
201 wxLogTrace(wxTRACE_OleCalls, wxT("wxIEnumFORMATETC::Next"));
202
203 if ( celt > 1 ) {
204 // we only return 1 element at a time - mainly because I'm too lazy to
205 // implement something which you're never asked for anyhow
206 return S_FALSE;
207 }
208
209 if ( m_nCurrent < m_nCount ) {
210 FORMATETC format;
211 format.cfFormat = m_formats[m_nCurrent++];
212 format.ptd = NULL;
213 format.dwAspect = DVASPECT_CONTENT;
214 format.lindex = -1;
215 format.tymed = TYMED_HGLOBAL;
216 *rgelt = format;
217
218 return S_OK;
219 }
220 else {
221 // bad index
222 return S_FALSE;
223 }
224}
225
226STDMETHODIMP wxIEnumFORMATETC::Skip(ULONG celt)
227{
228 wxLogTrace(wxTRACE_OleCalls, wxT("wxIEnumFORMATETC::Skip"));
229
230 m_nCurrent += celt;
231 if ( m_nCurrent < m_nCount )
232 return S_OK;
233
234 // no, can't skip this many elements
235 m_nCurrent -= celt;
236
237 return S_FALSE;
238}
239
240STDMETHODIMP wxIEnumFORMATETC::Reset()
241{
242 wxLogTrace(wxTRACE_OleCalls, wxT("wxIEnumFORMATETC::Reset"));
243
244 m_nCurrent = 0;
245
246 return S_OK;
247}
248
249STDMETHODIMP wxIEnumFORMATETC::Clone(IEnumFORMATETC **ppenum)
250{
251 wxLogTrace(wxTRACE_OleCalls, wxT("wxIEnumFORMATETC::Clone"));
252
253 // unfortunately, we can't reuse the code in ctor - types are different
254 wxIEnumFORMATETC *pNew = new wxIEnumFORMATETC(NULL, 0);
255 pNew->m_nCount = m_nCount;
256 pNew->m_formats = new CLIPFORMAT[m_nCount];
257 for ( ULONG n = 0; n < m_nCount; n++ ) {
258 pNew->m_formats[n] = m_formats[n];
259 }
260 pNew->AddRef();
261 *ppenum = pNew;
262
263 return S_OK;
264}
265
266// ----------------------------------------------------------------------------
267// wxIDataObject
268// ----------------------------------------------------------------------------
269
270BEGIN_IID_TABLE(wxIDataObject)
271 ADD_IID(Unknown)
272 ADD_IID(DataObject)
273END_IID_TABLE;
274
275IMPLEMENT_IUNKNOWN_METHODS(wxIDataObject)
276
277wxIDataObject::wxIDataObject(wxDataObject *pDataObject)
278{
279 m_cRef = 0;
280 m_pDataObject = pDataObject;
281 m_mustDelete = FALSE;
282}
283
284wxIDataObject::~wxIDataObject()
285{
286 if ( m_mustDelete )
287 {
288 delete m_pDataObject;
289 }
290}
291
292// get data functions
293STDMETHODIMP wxIDataObject::GetData(FORMATETC *pformatetcIn, STGMEDIUM *pmedium)
294{
295 wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::GetData"));
296
297 // is data is in our format?
298 HRESULT hr = QueryGetData(pformatetcIn);
299 if ( FAILED(hr) )
300 return hr;
301
302 // for the bitmaps and metafiles we use the handles instead of global memory
303 // to pass the data
304 wxDataFormat format = (wxDataFormatId)pformatetcIn->cfFormat;
305
306 switch ( format )
307 {
308 case wxDF_BITMAP:
309 pmedium->tymed = TYMED_GDI;
310 break;
311
312 case wxDF_ENHMETAFILE:
313 pmedium->tymed = TYMED_ENHMF;
314 break;
315
316 case wxDF_METAFILE:
317 pmedium->hGlobal = GlobalAlloc(GMEM_MOVEABLE | GMEM_SHARE,
318 sizeof(METAFILEPICT));
319 if ( !pmedium->hGlobal ) {
320 wxLogLastError(wxT("GlobalAlloc"));
321 return E_OUTOFMEMORY;
322 }
323 pmedium->tymed = TYMED_MFPICT;
324 break;
325
326 default:
327 // alloc memory
328 size_t size = m_pDataObject->GetDataSize(format);
329 if ( !size ) {
330 // it probably means that the method is just not implemented
331 wxLogDebug(wxT("Invalid data size - can't be 0"));
332
333 return DV_E_FORMATETC;
334 }
335
336 if ( !format.IsStandard() ) {
337 // for custom formats, put the size with the data - alloc the
338 // space for it
339 size += sizeof(size_t);
340 }
341
342 HGLOBAL hGlobal = GlobalAlloc(GMEM_MOVEABLE | GMEM_SHARE, size);
343 if ( hGlobal == NULL ) {
344 wxLogLastError(wxT("GlobalAlloc"));
345 return E_OUTOFMEMORY;
346 }
347
348 // copy data
349 pmedium->tymed = TYMED_HGLOBAL;
350 pmedium->hGlobal = hGlobal;
351 }
352
353 pmedium->pUnkForRelease = NULL;
354
355 // do copy the data
356 hr = GetDataHere(pformatetcIn, pmedium);
357 if ( FAILED(hr) ) {
358 // free resources we allocated
359 if ( pmedium->tymed & (TYMED_HGLOBAL | TYMED_MFPICT) ) {
360 GlobalFree(pmedium->hGlobal);
361 }
362
363 return hr;
364 }
365
366 return S_OK;
367}
368
369STDMETHODIMP wxIDataObject::GetDataHere(FORMATETC *pformatetc,
370 STGMEDIUM *pmedium)
371{
372 wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::GetDataHere"));
373
374 // put data in caller provided medium
375 switch ( pmedium->tymed )
376 {
377 case TYMED_GDI:
378 if ( !m_pDataObject->GetDataHere(wxDF_BITMAP, &pmedium->hBitmap) )
379 return E_UNEXPECTED;
380 break;
381
382 case TYMED_ENHMF:
383 if ( !m_pDataObject->GetDataHere(wxDF_ENHMETAFILE,
384 &pmedium->hEnhMetaFile) )
385 return E_UNEXPECTED;
386 break;
387
388 case TYMED_MFPICT:
389 // fall through - we pass METAFILEPICT through HGLOBAL
390
391 case TYMED_HGLOBAL:
392 {
393 // copy data
394 HGLOBAL hGlobal = pmedium->hGlobal;
395 void *pBuf = GlobalLock(hGlobal);
396 if ( pBuf == NULL ) {
397 wxLogLastError(wxT("GlobalLock"));
398 return E_OUTOFMEMORY;
399 }
400
401 if ( !wxDataFormat(pformatetc->cfFormat).IsStandard() ) {
402 // for custom formats, put the size with the data
403 size_t *p = (size_t *)pBuf;
404 *p++ = GlobalSize(hGlobal);
405 pBuf = p;
406 }
407
408 wxDataFormat format = pformatetc->cfFormat;
409 if ( !m_pDataObject->GetDataHere(format, pBuf) )
410 return E_UNEXPECTED;
411
412 GlobalUnlock(hGlobal);
413 }
414 break;
415
416 default:
417 return DV_E_TYMED;
418 }
419
420 return S_OK;
421}
422
423// set data functions
424STDMETHODIMP wxIDataObject::SetData(FORMATETC *pformatetc,
425 STGMEDIUM *pmedium,
426 BOOL fRelease)
427{
428 wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::SetData"));
429
430 switch ( pmedium->tymed )
431 {
432 case TYMED_GDI:
433 m_pDataObject->SetData(wxDF_BITMAP, 0, &pmedium->hBitmap);
434 break;
435
436 case TYMED_ENHMF:
437 m_pDataObject->SetData(wxDF_ENHMETAFILE, 0, &pmedium->hEnhMetaFile);
438 break;
439
440 case TYMED_MFPICT:
441 // fall through - we pass METAFILEPICT through HGLOBAL
442 case TYMED_HGLOBAL:
443 {
444 wxDataFormat format = pformatetc->cfFormat;
445
446 // this is quite weird, but for file drag and drop, explorer
447 // calls our SetData() with the formats we do *not* support!
448 //
449 // as we can't fix this bug in explorer (it's a bug because it
450 // should only use formats returned by EnumFormatEtc), do the
451 // check here
452 if ( !m_pDataObject->IsSupportedFormat(format) ) {
453 // go away!
454 return DV_E_FORMATETC;
455 }
456
457 // copy data
458 void *pBuf = GlobalLock(pmedium->hGlobal);
459 if ( pBuf == NULL ) {
460 wxLogLastError(wxT("GlobalLock"));
461
462 return E_OUTOFMEMORY;
463 }
464
465 // we've got a problem with SetData() here because the base
466 // class version requires the size parameter which we don't
467 // have anywhere in OLE data transfer - so we need to
468 // synthetise it for known formats and we suppose that all data
469 // in custom formats starts with a DWORD containing the size
470 size_t size;
471 switch ( format )
472 {
473 case CF_TEXT:
474 case CF_OEMTEXT:
475 size = strlen((const char *)pBuf);
476 break;
477#if !defined(__WATCOMC__) && ! (defined(__BORLANDC__) && (__BORLANDC__ < 0x500))
478 case CF_UNICODETEXT:
479#if (defined(__BORLANDC__) && (__BORLANDC__ > 0x530))
480 size = std::wcslen((const wchar_t *)pBuf);
481#else
482 size = ::wcslen((const wchar_t *)pBuf);
483#endif
484 break;
485#endif
486 case CF_BITMAP:
487 case CF_HDROP:
488 // these formats don't use size at all, anyhow (but
489 // pass data by handle, which is always a single DWORD)
490 size = 0;
491 break;
492
493 case CF_DIB:
494 // the handler will calculate size itself (it's too
495 // complicated to do it here)
496 size = 0;
497 break;
498
499 case CF_METAFILEPICT:
500 size = sizeof(METAFILEPICT);
501 break;
502
503 default:
504 {
505 // we suppose that the size precedes the data
506 size_t *p = (size_t *)pBuf;
507 size = *p++;
508 pBuf = p;
509 }
510 }
511
512 bool ok = m_pDataObject->SetData(format, size, pBuf);
513
514 GlobalUnlock(pmedium->hGlobal);
515
516 if ( !ok ) {
517 return E_UNEXPECTED;
518 }
519 }
520 break;
521
522 default:
523 return DV_E_TYMED;
524 }
525
526 if ( fRelease ) {
527 // we own the medium, so we must release it - but do *not* free any
528 // data we pass by handle because we have copied it elsewhere
529 switch ( pmedium->tymed )
530 {
531 case TYMED_GDI:
532 pmedium->hBitmap = 0;
533 break;
534
535 case TYMED_MFPICT:
536 pmedium->hMetaFilePict = 0;
537 break;
538
539 case TYMED_ENHMF:
540 pmedium->hEnhMetaFile = 0;
541 break;
542 }
543
544 ReleaseStgMedium(pmedium);
545 }
546
547 return S_OK;
548}
549
550// information functions
551STDMETHODIMP wxIDataObject::QueryGetData(FORMATETC *pformatetc)
552{
553 // do we accept data in this format?
554 if ( pformatetc == NULL ) {
555 wxLogTrace(wxTRACE_OleCalls,
556 wxT("wxIDataObject::QueryGetData: invalid ptr."));
557
558 return E_INVALIDARG;
559 }
560
561 // the only one allowed by current COM implementation
562 if ( pformatetc->lindex != -1 ) {
563 wxLogTrace(wxTRACE_OleCalls,
564 wxT("wxIDataObject::QueryGetData: bad lindex %d"),
565 pformatetc->lindex);
566
567 return DV_E_LINDEX;
568 }
569
570 // we don't support anything other (THUMBNAIL, ICON, DOCPRINT...)
571 if ( pformatetc->dwAspect != DVASPECT_CONTENT ) {
572 wxLogTrace(wxTRACE_OleCalls,
573 wxT("wxIDataObject::QueryGetData: bad dwAspect %d"),
574 pformatetc->dwAspect);
575
576 return DV_E_DVASPECT;
577 }
578
579 // and now check the type of data requested
580 wxDataFormat format = pformatetc->cfFormat;
581 if ( m_pDataObject->IsSupportedFormat(format) ) {
582 wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::QueryGetData: %s ok"),
583 wxGetFormatName(format));
584 }
585 else {
586 wxLogTrace(wxTRACE_OleCalls,
587 wxT("wxIDataObject::QueryGetData: %s unsupported"),
588 wxGetFormatName(format));
589
590 return DV_E_FORMATETC;
591 }
592
593 // we only transfer data by global memory, except for some particular cases
594 DWORD tymed = pformatetc->tymed;
595 if ( (format == wxDF_BITMAP && !(tymed & TYMED_GDI)) &&
596 !(tymed & TYMED_HGLOBAL) ) {
597 // it's not what we're waiting for
598 wxLogTrace(wxTRACE_OleCalls,
599 wxT("wxIDataObject::QueryGetData: %s != %s"),
600 GetTymedName(tymed),
601 GetTymedName(format == wxDF_BITMAP ? TYMED_GDI
602 : TYMED_HGLOBAL));
603
604 return DV_E_TYMED;
605 }
606
607 return S_OK;
608}
609
610STDMETHODIMP wxIDataObject::GetCanonicalFormatEtc(FORMATETC *pFormatetcIn,
611 FORMATETC *pFormatetcOut)
612{
613 wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::GetCanonicalFormatEtc"));
614
615 // TODO we might want something better than this trivial implementation here
616 if ( pFormatetcOut != NULL )
617 pFormatetcOut->ptd = NULL;
618
619 return DATA_S_SAMEFORMATETC;
620}
621
622STDMETHODIMP wxIDataObject::EnumFormatEtc(DWORD dwDir,
623 IEnumFORMATETC **ppenumFormatEtc)
624{
625 wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::EnumFormatEtc"));
626
627 wxDataObject::Direction dir = dwDir == DATADIR_GET ? wxDataObject::Get
628 : wxDataObject::Set;
629
630 size_t nFormatCount = m_pDataObject->GetFormatCount(dir);
631 wxDataFormat format, *formats;
632 formats = nFormatCount == 1 ? &format : new wxDataFormat[nFormatCount];
633 m_pDataObject->GetAllFormats(formats, dir);
634
635 wxIEnumFORMATETC *pEnum = new wxIEnumFORMATETC(formats, nFormatCount);
636 pEnum->AddRef();
637 *ppenumFormatEtc = pEnum;
638
639 if ( formats != &format ) {
640 delete [] formats;
641 }
642
643 return S_OK;
644}
645
646// ----------------------------------------------------------------------------
647// advise sink functions (not implemented)
648// ----------------------------------------------------------------------------
649
650STDMETHODIMP wxIDataObject::DAdvise(FORMATETC *pformatetc,
651 DWORD advf,
652 IAdviseSink *pAdvSink,
653 DWORD *pdwConnection)
654{
655 return OLE_E_ADVISENOTSUPPORTED;
656}
657
658STDMETHODIMP wxIDataObject::DUnadvise(DWORD dwConnection)
659{
660 return OLE_E_ADVISENOTSUPPORTED;
661}
662
663STDMETHODIMP wxIDataObject::EnumDAdvise(IEnumSTATDATA **ppenumAdvise)
664{
665 return OLE_E_ADVISENOTSUPPORTED;
666}
667
668// ----------------------------------------------------------------------------
669// wxDataObject
670// ----------------------------------------------------------------------------
671
672wxDataObject::wxDataObject()
673{
674 m_pIDataObject = new wxIDataObject(this);
675 m_pIDataObject->AddRef();
676}
677
678wxDataObject::~wxDataObject()
679{
680 ReleaseInterface(m_pIDataObject);
681}
682
683void wxDataObject::SetAutoDelete()
684{
685 ((wxIDataObject *)m_pIDataObject)->SetDeleteFlag();
686 m_pIDataObject->Release();
687
688 // so that the dtor doesnt' crash
689 m_pIDataObject = NULL;
690}
691
692#ifdef __WXDEBUG__
693
694const wxChar *wxDataObject::GetFormatName(wxDataFormat format)
695{
696 // case 'xxx' is not a valid value for switch of enum 'wxDataFormat'
697 #ifdef __VISUALC__
698 #pragma warning(disable:4063)
699 #endif // VC++
700
701 static wxChar s_szBuf[256];
702 switch ( format ) {
703 case CF_TEXT: return wxT("CF_TEXT");
704 case CF_BITMAP: return wxT("CF_BITMAP");
705 case CF_METAFILEPICT: return wxT("CF_METAFILEPICT");
706 case CF_SYLK: return wxT("CF_SYLK");
707 case CF_DIF: return wxT("CF_DIF");
708 case CF_TIFF: return wxT("CF_TIFF");
709 case CF_OEMTEXT: return wxT("CF_OEMTEXT");
710 case CF_DIB: return wxT("CF_DIB");
711 case CF_PALETTE: return wxT("CF_PALETTE");
712 case CF_PENDATA: return wxT("CF_PENDATA");
713 case CF_RIFF: return wxT("CF_RIFF");
714 case CF_WAVE: return wxT("CF_WAVE");
715 case CF_UNICODETEXT: return wxT("CF_UNICODETEXT");
716 case CF_ENHMETAFILE: return wxT("CF_ENHMETAFILE");
717 case CF_HDROP: return wxT("CF_HDROP");
718 case CF_LOCALE: return wxT("CF_LOCALE");
719
720 default:
721 if ( !::GetClipboardFormatName(format, s_szBuf, WXSIZEOF(s_szBuf)) )
722 {
723 // it must be a new predefined format we don't know the name of
724 wxSprintf(s_szBuf, wxT("unknown CF (0x%04x)"), format.GetFormatId());
725 }
726
727 return s_szBuf;
728 }
729
730 #ifdef __VISUALC__
731 #pragma warning(default:4063)
732 #endif // VC++
733}
734
735#endif // Debug
736
737// ----------------------------------------------------------------------------
738// wxBitmapDataObject supports CF_DIB format
739// ----------------------------------------------------------------------------
740
741size_t wxBitmapDataObject::GetDataSize() const
742{
743 return wxConvertBitmapToDIB(NULL, GetBitmap());
744}
745
746bool wxBitmapDataObject::GetDataHere(void *buf) const
747{
748 return wxConvertBitmapToDIB((LPBITMAPINFO)buf, GetBitmap()) != 0;
749}
750
751bool wxBitmapDataObject::SetData(size_t len, const void *buf)
752{
753 wxBitmap bitmap(wxConvertDIBToBitmap((const LPBITMAPINFO)buf));
754
755 if ( !bitmap.Ok() ) {
756 wxFAIL_MSG(wxT("pasting/dropping invalid bitmap"));
757
758 return FALSE;
759 }
760
761 SetBitmap(bitmap);
762
763 return TRUE;
764}
765
766// ----------------------------------------------------------------------------
767// wxBitmapDataObject2 supports CF_BITMAP format
768// ----------------------------------------------------------------------------
769
770// the bitmaps aren't passed by value as other types of data (i.e. by copying
771// the data into a global memory chunk and passing it to the clipboard or
772// another application or whatever), but by handle, so these generic functions
773// don't make much sense to them.
774
775size_t wxBitmapDataObject2::GetDataSize() const
776{
777 return 0;
778}
779
780bool wxBitmapDataObject2::GetDataHere(void *pBuf) const
781{
782 // we put a bitmap handle into pBuf
783 *(WXHBITMAP *)pBuf = GetBitmap().GetHBITMAP();
784
785 return TRUE;
786}
787
788bool wxBitmapDataObject2::SetData(size_t WXUNUSED(len), const void *pBuf)
789{
790 HBITMAP hbmp = *(HBITMAP *)pBuf;
791
792 BITMAP bmp;
793 if ( !GetObject(hbmp, sizeof(BITMAP), &bmp) )
794 {
795 wxLogLastError(wxT("GetObject(HBITMAP)"));
796 }
797
798 wxBitmap bitmap(bmp.bmWidth, bmp.bmHeight, bmp.bmPlanes);
799 bitmap.SetHBITMAP((WXHBITMAP)hbmp);
800
801 if ( !bitmap.Ok() ) {
802 wxFAIL_MSG(wxT("pasting/dropping invalid bitmap"));
803
804 return FALSE;
805 }
806
807 SetBitmap(bitmap);
808
809 return TRUE;
810}
811
812#if 0
813
814size_t wxBitmapDataObject::GetDataSize(const wxDataFormat& format) const
815{
816 if ( format.GetFormatId() == CF_DIB )
817 {
818 // create the DIB
819 ScreenHDC hdc;
820
821 // shouldn't be selected into a DC or GetDIBits() would fail
822 wxASSERT_MSG( !m_bitmap.GetSelectedInto(),
823 wxT("can't copy bitmap selected into wxMemoryDC") );
824
825 // first get the info
826 BITMAPINFO bi;
827 if ( !GetDIBits(hdc, (HBITMAP)m_bitmap.GetHBITMAP(), 0, 0,
828 NULL, &bi, DIB_RGB_COLORS) )
829 {
830 wxLogLastError(wxT("GetDIBits(NULL)"));
831
832 return 0;
833 }
834
835 return sizeof(BITMAPINFO) + bi.bmiHeader.biSizeImage;
836 }
837 else // CF_BITMAP
838 {
839 // no data to copy - we don't pass HBITMAP via global memory
840 return 0;
841 }
842}
843
844bool wxBitmapDataObject::GetDataHere(const wxDataFormat& format,
845 void *pBuf) const
846{
847 wxASSERT_MSG( m_bitmap.Ok(), wxT("copying invalid bitmap") );
848
849 HBITMAP hbmp = (HBITMAP)m_bitmap.GetHBITMAP();
850 if ( format.GetFormatId() == CF_DIB )
851 {
852 // create the DIB
853 ScreenHDC hdc;
854
855 // shouldn't be selected into a DC or GetDIBits() would fail
856 wxASSERT_MSG( !m_bitmap.GetSelectedInto(),
857 wxT("can't copy bitmap selected into wxMemoryDC") );
858
859 // first get the info
860 BITMAPINFO *pbi = (BITMAPINFO *)pBuf;
861 if ( !GetDIBits(hdc, hbmp, 0, 0, NULL, pbi, DIB_RGB_COLORS) )
862 {
863 wxLogLastError(wxT("GetDIBits(NULL)"));
864
865 return 0;
866 }
867
868 // and now copy the bits
869 if ( !GetDIBits(hdc, hbmp, 0, pbi->bmiHeader.biHeight, pbi + 1,
870 pbi, DIB_RGB_COLORS) )
871 {
872 wxLogLastError(wxT("GetDIBits"));
873
874 return FALSE;
875 }
876 }
877 else // CF_BITMAP
878 {
879 // we put a bitmap handle into pBuf
880 *(HBITMAP *)pBuf = hbmp;
881 }
882
883 return TRUE;
884}
885
886bool wxBitmapDataObject::SetData(const wxDataFormat& format,
887 size_t size, const void *pBuf)
888{
889 HBITMAP hbmp;
890 if ( format.GetFormatId() == CF_DIB )
891 {
892 // here we get BITMAPINFO struct followed by the actual bitmap bits and
893 // BITMAPINFO starts with BITMAPINFOHEADER followed by colour info
894 ScreenHDC hdc;
895
896 BITMAPINFO *pbmi = (BITMAPINFO *)pBuf;
897 BITMAPINFOHEADER *pbmih = &pbmi->bmiHeader;
898 hbmp = CreateDIBitmap(hdc, pbmih, CBM_INIT,
899 pbmi + 1, pbmi, DIB_RGB_COLORS);
900 if ( !hbmp )
901 {
902 wxLogLastError(wxT("CreateDIBitmap"));
903 }
904
905 m_bitmap.SetWidth(pbmih->biWidth);
906 m_bitmap.SetHeight(pbmih->biHeight);
907 }
908 else // CF_BITMAP
909 {
910 // it's easy with bitmaps: we pass them by handle
911 hbmp = *(HBITMAP *)pBuf;
912
913 BITMAP bmp;
914 if ( !GetObject(hbmp, sizeof(BITMAP), &bmp) )
915 {
916 wxLogLastError(wxT("GetObject(HBITMAP)"));
917 }
918
919 m_bitmap.SetWidth(bmp.bmWidth);
920 m_bitmap.SetHeight(bmp.bmHeight);
921 m_bitmap.SetDepth(bmp.bmPlanes);
922 }
923
924 m_bitmap.SetHBITMAP((WXHBITMAP)hbmp);
925
926 wxASSERT_MSG( m_bitmap.Ok(), wxT("pasting invalid bitmap") );
927
928 return TRUE;
929}
930
931#endif // 0
932
933// ----------------------------------------------------------------------------
934// wxFileDataObject
935// ----------------------------------------------------------------------------
936
937bool wxFileDataObject::SetData(size_t WXUNUSED(size), const void *pData)
938{
939 m_filenames.Empty();
940
941 // the documentation states that the first member of DROPFILES structure is
942 // a "DWORD offset of double NUL terminated file list". What they mean by
943 // this (I wonder if you see it immediately) is that the list starts at
944 // ((char *)&(pDropFiles.pFiles)) + pDropFiles.pFiles. We're also advised
945 // to use DragQueryFile to work with this structure, but not told where and
946 // how to get HDROP.
947 HDROP hdrop = (HDROP)pData; // NB: it works, but I'm not sure about it
948
949 // get number of files (magic value -1)
950 UINT nFiles = ::DragQueryFile(hdrop, (unsigned)-1, NULL, 0u);
951
952 wxCHECK_MSG ( nFiles != (UINT)-1, FALSE, wxT("wrong HDROP handle") );
953
954 // for each file get the length, allocate memory and then get the name
955 wxString str;
956 UINT len, n;
957 for ( n = 0; n < nFiles; n++ ) {
958 // +1 for terminating NUL
959 len = ::DragQueryFile(hdrop, n, NULL, 0) + 1;
960
961 UINT len2 = ::DragQueryFile(hdrop, n, str.GetWriteBuf(len), len);
962 str.UngetWriteBuf();
963 m_filenames.Add(str);
964
965 if ( len2 != len - 1 ) {
966 wxLogDebug(wxT("In wxFileDropTarget::OnDrop DragQueryFile returned\
967 %d characters, %d expected."), len2, len - 1);
968 }
969 }
970
971 return TRUE;
972}
973
974void wxFileDataObject::AddFile(const wxString& file)
975{
976 // just add file to filenames array
977 // all useful data (such as DROPFILES struct) will be
978 // created later as necessary
979 m_filenames.Add(file);
980}
981
982size_t wxFileDataObject::GetDataSize() const
983{
984 // size returned will be the size of the DROPFILES structure,
985 // plus the list of filesnames (null byte separated), plus
986 // a double null at the end
987
988 // if no filenames in list, size is 0
989 if ( m_filenames.GetCount() == 0 )
990 return 0;
991
992 // inital size of DROPFILES struct + null byte
993 size_t sz = sizeof(DROPFILES) + 1;
994
995 size_t count = m_filenames.GetCount();
996 for ( size_t i = 0; i < count; i++ )
997 {
998 // add filename length plus null byte
999 sz += m_filenames[i].Len() + 1;
1000 }
1001
1002 return sz;
1003}
1004
1005bool wxFileDataObject::GetDataHere(void *pData) const
1006{
1007 // pData points to an externally allocated memory block
1008 // created using the size returned by GetDataSize()
1009
1010 // if pData is NULL, or there are no files, return
1011 if ( !pData || m_filenames.GetCount() == 0 )
1012 return FALSE;
1013
1014 // convert data pointer to a DROPFILES struct pointer
1015 LPDROPFILES pDrop = (LPDROPFILES) pData;
1016
1017 // initialize DROPFILES struct
1018 pDrop->pFiles = sizeof(DROPFILES);
1019 pDrop->fNC = FALSE; // not non-client coords
1020#if wxUSE_UNICODE
1021 pDrop->fWide = TRUE;
1022#else // ANSI
1023 pDrop->fWide = FALSE;
1024#endif // Unicode/Ansi
1025
1026 // set start of filenames list (null separated)
1027 wxChar *pbuf = (wxChar*) ((BYTE *)pDrop + sizeof(DROPFILES));
1028
1029 size_t count = m_filenames.GetCount();
1030 for (size_t i = 0; i < count; i++ )
1031 {
1032 // copy filename to pbuf and add null terminator
1033 size_t len = m_filenames[i].Len();
1034 memcpy(pbuf, m_filenames[i], len);
1035 pbuf += len;
1036 *pbuf++ = wxT('\0');
1037 }
1038
1039 *pbuf = wxT('\0'); // add final null terminator
1040
1041 return TRUE;
1042}
1043
1044// ----------------------------------------------------------------------------
1045// private functions
1046// ----------------------------------------------------------------------------
1047
1048static size_t wxGetNumOfBitmapColors(size_t bitsPerPixel)
1049{
1050 switch ( bitsPerPixel )
1051 {
1052 case 1:
1053 // monochrome bitmap, 2 entries
1054 return 2;
1055
1056 case 4:
1057 return 16;
1058
1059 case 8:
1060 return 256;
1061
1062 case 24:
1063 // may be used with 24bit bitmaps, but we don't use it here - fall
1064 // through
1065
1066 case 16:
1067 case 32:
1068 // bmiColors not used at all with these bitmaps
1069 return 0;
1070
1071 default:
1072 wxFAIL_MSG( wxT("unknown bitmap format") );
1073 return 0;
1074 }
1075}
1076
1077size_t wxConvertBitmapToDIB(LPBITMAPINFO pbi, const wxBitmap& bitmap)
1078{
1079 wxASSERT_MSG( bitmap.Ok(), wxT("invalid bmp can't be converted to DIB") );
1080
1081 // shouldn't be selected into a DC or GetDIBits() would fail
1082 wxASSERT_MSG( !bitmap.GetSelectedInto(),
1083 wxT("can't copy bitmap selected into wxMemoryDC") );
1084
1085 // prepare all the info we need
1086 BITMAP bm;
1087 HBITMAP hbmp = (HBITMAP)bitmap.GetHBITMAP();
1088 if ( !GetObject(hbmp, sizeof(bm), &bm) )
1089 {
1090 wxLogLastError(wxT("GetObject(bitmap)"));
1091
1092 return 0;
1093 }
1094
1095 // calculate the number of bits per pixel and the number of items in
1096 // bmiColors array (whose meaning depends on the bitmap format)
1097 WORD biBits = bm.bmPlanes * bm.bmBitsPixel;
1098 WORD biColors = wxGetNumOfBitmapColors(biBits);
1099
1100 BITMAPINFO bi2;
1101
1102 bool wantSizeOnly = pbi == NULL;
1103 if ( wantSizeOnly )
1104 pbi = &bi2;
1105
1106 // just for convenience
1107 BITMAPINFOHEADER& bi = pbi->bmiHeader;
1108
1109 bi.biSize = sizeof(BITMAPINFOHEADER);
1110 bi.biWidth = bm.bmWidth;
1111 bi.biHeight = bm.bmHeight;
1112 bi.biPlanes = 1;
1113 bi.biBitCount = biBits;
1114 bi.biCompression = BI_RGB;
1115 bi.biSizeImage = 0;
1116 bi.biXPelsPerMeter = 0;
1117 bi.biYPelsPerMeter = 0;
1118 bi.biClrUsed = 0;
1119 bi.biClrImportant = 0;
1120
1121 // memory we need for BITMAPINFO only
1122 DWORD dwLen = bi.biSize + biColors * sizeof(RGBQUAD);
1123
1124 // first get the image size
1125 ScreenHDC hdc;
1126 if ( !GetDIBits(hdc, hbmp, 0, bi.biHeight, NULL, pbi, DIB_RGB_COLORS) )
1127 {
1128 wxLogLastError(wxT("GetDIBits(NULL)"));
1129
1130 return 0;
1131 }
1132
1133 if ( wantSizeOnly )
1134 {
1135 // size of the header + size of the image
1136 return dwLen + bi.biSizeImage;
1137 }
1138
1139 // and now copy the bits
1140 void *image = (char *)pbi + dwLen;
1141 if ( !GetDIBits(hdc, hbmp, 0, bi.biHeight, image, pbi, DIB_RGB_COLORS) )
1142 {
1143 wxLogLastError(wxT("GetDIBits"));
1144
1145 return 0;
1146 }
1147
1148 return dwLen + bi.biSizeImage;
1149}
1150
1151wxBitmap wxConvertDIBToBitmap(const LPBITMAPINFO pbmi)
1152{
1153 // here we get BITMAPINFO struct followed by the actual bitmap bits and
1154 // BITMAPINFO starts with BITMAPINFOHEADER followed by colour info
1155 const BITMAPINFOHEADER *pbmih = &pbmi->bmiHeader;
1156
1157 // offset of image from the beginning of the header
1158 DWORD ofs = wxGetNumOfBitmapColors(pbmih->biBitCount) * sizeof(RGBQUAD);
1159 void *image = (char *)pbmih + sizeof(BITMAPINFOHEADER) + ofs;
1160
1161 ScreenHDC hdc;
1162 HBITMAP hbmp = CreateDIBitmap(hdc, pbmih, CBM_INIT,
1163 image, pbmi, DIB_RGB_COLORS);
1164 if ( !hbmp )
1165 {
1166 wxLogLastError(wxT("CreateDIBitmap"));
1167 }
1168
1169 wxBitmap bitmap(pbmih->biWidth, pbmih->biHeight, pbmih->biBitCount);
1170 bitmap.SetHBITMAP((WXHBITMAP)hbmp);
1171
1172 return bitmap;
1173}
1174
1175#ifdef __WXDEBUG__
1176
1177static const wxChar *GetTymedName(DWORD tymed)
1178{
1179 static wxChar s_szBuf[128];
1180 switch ( tymed ) {
1181 case TYMED_HGLOBAL: return wxT("TYMED_HGLOBAL");
1182 case TYMED_FILE: return wxT("TYMED_FILE");
1183 case TYMED_ISTREAM: return wxT("TYMED_ISTREAM");
1184 case TYMED_ISTORAGE: return wxT("TYMED_ISTORAGE");
1185 case TYMED_GDI: return wxT("TYMED_GDI");
1186 case TYMED_MFPICT: return wxT("TYMED_MFPICT");
1187 case TYMED_ENHMF: return wxT("TYMED_ENHMF");
1188 default:
1189 wxSprintf(s_szBuf, wxT("type of media format %ld (unknown)"), tymed);
1190 return s_szBuf;
1191 }
1192}
1193
1194#endif // Debug
1195
1196#endif // not using OLE at all
1197