1. wxDropTarget::OnData() returns wxDragResult now, not bool
[wxWidgets.git] / src / msw / clipbrd.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: clipbrd.cpp
3 // Purpose: Clipboard functionality
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 04/01/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ===========================================================================
13 // declarations
14 // ===========================================================================
15
16 // ---------------------------------------------------------------------------
17 // headers
18 // ---------------------------------------------------------------------------
19
20 #ifdef __GNUG__
21 #pragma implementation "clipbrd.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 #ifndef WX_PRECOMP
32 #include "wx/setup.h"
33 #endif
34
35 #if wxUSE_CLIPBOARD
36
37 #ifndef WX_PRECOMP
38 #include "wx/object.h"
39 #include "wx/event.h"
40 #include "wx/app.h"
41 #include "wx/frame.h"
42 #include "wx/bitmap.h"
43 #include "wx/utils.h"
44 #include "wx/intl.h"
45 #endif
46
47 #if wxUSE_METAFILE
48 #include "wx/metafile.h"
49 #endif
50
51 #include "wx/log.h"
52 #include "wx/clipbrd.h"
53
54 #include <string.h>
55 #include <windows.h>
56
57 #include "wx/msw/private.h"
58 #include "wx/msw/dib.h"
59
60 // wxDataObject is tied to OLE/drag and drop implementation, therefore so are
61 // the functions using wxDataObject in wxClipboard
62 #define wxUSE_DATAOBJ wxUSE_DRAG_AND_DROP
63
64 #if wxUSE_DATAOBJ
65 #include "wx/dataobj.h"
66
67 // use OLE clipboard
68 #define wxUSE_OLE_CLIPBOARD 1
69 #else // !wxUSE_DATAOBJ
70 // use Win clipboard API
71 #define wxUSE_OLE_CLIPBOARD 0
72 #endif
73
74 #if wxUSE_OLE_CLIPBOARD
75 #include <ole2.h>
76 #endif // wxUSE_OLE_CLIPBOARD
77
78 #ifdef __WIN16__
79 #define memcpy hmemcpy
80 #endif
81
82 // ===========================================================================
83 // implementation
84 // ===========================================================================
85
86 // ---------------------------------------------------------------------------
87 // old-style clipboard functions using Windows API
88 // ---------------------------------------------------------------------------
89
90 static bool gs_wxClipboardIsOpen = FALSE;
91
92 bool wxOpenClipboard()
93 {
94 wxCHECK_MSG( !gs_wxClipboardIsOpen, TRUE, wxT("clipboard already opened.") );
95
96 wxWindow *win = wxTheApp->GetTopWindow();
97 if ( win )
98 {
99 gs_wxClipboardIsOpen = ::OpenClipboard((HWND)win->GetHWND()) != 0;
100
101 if ( !gs_wxClipboardIsOpen )
102 wxLogSysError(_("Failed to open the clipboard."));
103
104 return gs_wxClipboardIsOpen;
105 }
106 else
107 {
108 wxLogDebug(wxT("Can not open clipboard without a main window."));
109
110 return FALSE;
111 }
112 }
113
114 bool wxCloseClipboard()
115 {
116 wxCHECK_MSG( gs_wxClipboardIsOpen, FALSE, wxT("clipboard is not opened") );
117
118 gs_wxClipboardIsOpen = FALSE;
119
120 if ( ::CloseClipboard() == 0 )
121 {
122 wxLogSysError(_("Failed to close the clipboard."));
123
124 return FALSE;
125 }
126
127 return TRUE;
128 }
129
130 bool wxEmptyClipboard()
131 {
132 if ( ::EmptyClipboard() == 0 )
133 {
134 wxLogSysError(_("Failed to empty the clipboard."));
135
136 return FALSE;
137 }
138
139 return TRUE;
140 }
141
142 bool wxIsClipboardOpened()
143 {
144 return gs_wxClipboardIsOpen;
145 }
146
147 bool wxIsClipboardFormatAvailable(wxDataFormat dataFormat)
148 {
149 // for bitmaps, DIBs will also do
150 return (::IsClipboardFormatAvailable(dataFormat) != 0) ||
151 (dataFormat.GetFormatId() == CF_BITMAP &&
152 ::IsClipboardFormatAvailable(CF_DIB));
153 }
154
155 bool wxSetClipboardData(wxDataFormat dataFormat,
156 const void *data,
157 int width, int height)
158 {
159 HANDLE handle = 0; // return value of SetClipboardData
160
161 switch (dataFormat)
162 {
163 case wxDF_BITMAP:
164 {
165 wxBitmap *bitmap = (wxBitmap *)data;
166
167 HDC hdcMem = CreateCompatibleDC((HDC) NULL);
168 HDC hdcSrc = CreateCompatibleDC((HDC) NULL);
169 HBITMAP old = (HBITMAP)
170 ::SelectObject(hdcSrc, (HBITMAP)bitmap->GetHBITMAP());
171 HBITMAP hBitmap = CreateCompatibleBitmap(hdcSrc,
172 bitmap->GetWidth(),
173 bitmap->GetHeight());
174 if (!hBitmap)
175 {
176 SelectObject(hdcSrc, old);
177 DeleteDC(hdcMem);
178 DeleteDC(hdcSrc);
179 return FALSE;
180 }
181
182 HBITMAP old1 = (HBITMAP) SelectObject(hdcMem, hBitmap);
183 BitBlt(hdcMem, 0, 0, bitmap->GetWidth(), bitmap->GetHeight(),
184 hdcSrc, 0, 0, SRCCOPY);
185
186 // Select new bitmap out of memory DC
187 SelectObject(hdcMem, old1);
188
189 // Set the data
190 handle = ::SetClipboardData(CF_BITMAP, hBitmap);
191
192 // Clean up
193 SelectObject(hdcSrc, old);
194 DeleteDC(hdcSrc);
195 DeleteDC(hdcMem);
196 break;
197 }
198
199 case wxDF_DIB:
200 {
201 #if wxUSE_IMAGE_LOADING_IN_MSW
202 wxBitmap *bitmap = (wxBitmap *)data;
203 HBITMAP hBitmap = (HBITMAP)bitmap->GetHBITMAP();
204 // NULL palette means to use the system one
205 HANDLE hDIB = wxBitmapToDIB(hBitmap, (HPALETTE)NULL);
206 handle = SetClipboardData(CF_DIB, hDIB);
207 #endif // wxUSE_IMAGE_LOADING_IN_MSW
208 break;
209 }
210
211 #if wxUSE_METAFILE
212 case wxDF_METAFILE:
213 {
214 wxMetafile *wxMF = (wxMetafile *)data;
215 HANDLE data = GlobalAlloc(GHND, sizeof(METAFILEPICT) + 1);
216 METAFILEPICT *mf = (METAFILEPICT *)GlobalLock(data);
217
218 mf->mm = wxMF->GetWindowsMappingMode();
219 mf->xExt = width;
220 mf->yExt = height;
221 mf->hMF = (HMETAFILE) wxMF->GetHMETAFILE();
222 GlobalUnlock(data);
223 wxMF->SetHMETAFILE((WXHANDLE) NULL);
224
225 handle = SetClipboardData(CF_METAFILEPICT, data);
226 break;
227 }
228 #endif
229 case CF_SYLK:
230 case CF_DIF:
231 case CF_TIFF:
232 case CF_PALETTE:
233 default:
234 {
235 wxLogError(_("Unsupported clipboard format."));
236 return FALSE;
237 }
238
239 case wxDF_OEMTEXT:
240 dataFormat = wxDF_TEXT;
241 // fall through
242
243 case wxDF_TEXT:
244 {
245 char *s = (char *)data;
246
247 width = strlen(s) + 1;
248 height = 1;
249 DWORD l = (width * height);
250 HANDLE hGlobalMemory = GlobalAlloc(GHND, l);
251 if ( hGlobalMemory )
252 {
253 LPSTR lpGlobalMemory = (LPSTR)GlobalLock(hGlobalMemory);
254
255 memcpy(lpGlobalMemory, s, l);
256
257 GlobalUnlock(hGlobalMemory);
258 }
259
260 handle = SetClipboardData(dataFormat, hGlobalMemory);
261 break;
262 }
263 }
264
265 if ( handle == 0 )
266 {
267 wxLogSysError(_("Failed to set clipboard data."));
268
269 return FALSE;
270 }
271
272 return TRUE;
273 }
274
275 void *wxGetClipboardData(wxDataFormat dataFormat, long *len)
276 {
277 void *retval = NULL;
278
279 switch ( dataFormat )
280 {
281 case wxDF_BITMAP:
282 {
283 BITMAP bm;
284 HBITMAP hBitmap = (HBITMAP) GetClipboardData(CF_BITMAP);
285 if (!hBitmap)
286 break;
287
288 HDC hdcMem = CreateCompatibleDC((HDC) NULL);
289 HDC hdcSrc = CreateCompatibleDC((HDC) NULL);
290
291 HBITMAP old = (HBITMAP) ::SelectObject(hdcSrc, hBitmap);
292 GetObject(hBitmap, sizeof(BITMAP), (LPSTR)&bm);
293
294 HBITMAP hNewBitmap = CreateBitmapIndirect(&bm);
295
296 if (!hNewBitmap)
297 {
298 SelectObject(hdcSrc, old);
299 DeleteDC(hdcMem);
300 DeleteDC(hdcSrc);
301 break;
302 }
303
304 HBITMAP old1 = (HBITMAP) SelectObject(hdcMem, hNewBitmap);
305 BitBlt(hdcMem, 0, 0, bm.bmWidth, bm.bmHeight,
306 hdcSrc, 0, 0, SRCCOPY);
307
308 // Select new bitmap out of memory DC
309 SelectObject(hdcMem, old1);
310
311 // Clean up
312 SelectObject(hdcSrc, old);
313 DeleteDC(hdcSrc);
314 DeleteDC(hdcMem);
315
316 // Create and return a new wxBitmap
317 wxBitmap *wxBM = new wxBitmap;
318 wxBM->SetHBITMAP((WXHBITMAP) hNewBitmap);
319 wxBM->SetWidth(bm.bmWidth);
320 wxBM->SetHeight(bm.bmHeight);
321 wxBM->SetDepth(bm.bmPlanes);
322 wxBM->SetOk(TRUE);
323 retval = wxBM;
324 break;
325 }
326
327 case wxDF_METAFILE:
328 case CF_SYLK:
329 case CF_DIF:
330 case CF_TIFF:
331 case CF_PALETTE:
332 case wxDF_DIB:
333 {
334 wxLogError(_("Unsupported clipboard format."));
335 return FALSE;
336 }
337
338 case wxDF_OEMTEXT:
339 dataFormat = wxDF_TEXT;
340 // fall through
341
342 case wxDF_TEXT:
343 {
344 HANDLE hGlobalMemory = ::GetClipboardData(dataFormat);
345 if (!hGlobalMemory)
346 break;
347
348 DWORD hsize = ::GlobalSize(hGlobalMemory);
349 if (len)
350 *len = hsize;
351
352 char *s = new char[hsize];
353 if (!s)
354 break;
355
356 LPSTR lpGlobalMemory = (LPSTR)::GlobalLock(hGlobalMemory);
357
358 memcpy(s, lpGlobalMemory, hsize);
359
360 ::GlobalUnlock(hGlobalMemory);
361
362 retval = s;
363 break;
364 }
365
366 default:
367 {
368 HANDLE hGlobalMemory = ::GetClipboardData(dataFormat);
369 if ( !hGlobalMemory )
370 break;
371
372 DWORD size = ::GlobalSize(hGlobalMemory);
373 if ( len )
374 *len = size;
375
376 void *buf = malloc(size);
377 if ( !buf )
378 break;
379
380 LPSTR lpGlobalMemory = (LPSTR)::GlobalLock(hGlobalMemory);
381
382 memcpy(buf, lpGlobalMemory, size);
383
384 ::GlobalUnlock(hGlobalMemory);
385
386 retval = buf;
387 break;
388 }
389 }
390
391 if ( !retval )
392 {
393 wxLogSysError(_("Failed to retrieve data from the clipboard."));
394 }
395
396 return retval;
397 }
398
399 wxDataFormat wxEnumClipboardFormats(wxDataFormat dataFormat)
400 {
401 return ::EnumClipboardFormats(dataFormat);
402 }
403
404 int wxRegisterClipboardFormat(wxChar *formatName)
405 {
406 return ::RegisterClipboardFormat(formatName);
407 }
408
409 bool wxGetClipboardFormatName(wxDataFormat dataFormat,
410 wxChar *formatName,
411 int maxCount)
412 {
413 return ::GetClipboardFormatName((int)dataFormat, formatName, maxCount) > 0;
414 }
415
416 // ---------------------------------------------------------------------------
417 // wxClipboard
418 // ---------------------------------------------------------------------------
419
420 IMPLEMENT_DYNAMIC_CLASS(wxClipboard, wxObject)
421
422 wxClipboard::wxClipboard()
423 {
424 m_clearOnExit = FALSE;
425 }
426
427 wxClipboard::~wxClipboard()
428 {
429 if ( m_clearOnExit )
430 {
431 Clear();
432 }
433 }
434
435 void wxClipboard::Clear()
436 {
437 #if wxUSE_OLE_CLIPBOARD
438 if ( FAILED(OleSetClipboard(NULL)) )
439 {
440 wxLogLastError("OleSetClipboard(NULL)");
441 }
442 #endif
443 }
444
445 bool wxClipboard::Flush()
446 {
447 #if wxUSE_OLE_CLIPBOARD
448 if ( FAILED(OleFlushClipboard()) )
449 {
450 wxLogLastError("OleFlushClipboard");
451
452 return FALSE;
453 }
454 else
455 {
456 m_clearOnExit = FALSE;
457
458 return TRUE;
459 }
460 #else // !wxUSE_OLE_CLIPBOARD
461 return FALSE;
462 #endif // wxUSE_OLE_CLIPBOARD/!wxUSE_OLE_CLIPBOARD
463 }
464
465 bool wxClipboard::Open()
466 {
467 // OLE opens clipboard for us
468 #if wxUSE_OLE_CLIPBOARD
469 return TRUE;
470 #else
471 return wxOpenClipboard();
472 #endif
473 }
474
475 bool wxClipboard::IsOpened() const
476 {
477 #if wxUSE_OLE_CLIPBOARD
478 return TRUE;
479 #else
480 return wxIsClipboardOpened();
481 #endif
482 }
483
484 bool wxClipboard::SetData( wxDataObject *data )
485 {
486 (void)wxEmptyClipboard();
487
488 if ( data )
489 return AddData(data);
490 else
491 return TRUE;
492 }
493
494 bool wxClipboard::AddData( wxDataObject *data )
495 {
496 wxCHECK_MSG( data, FALSE, wxT("data is invalid") );
497
498 #if wxUSE_OLE_CLIPBOARD
499 HRESULT hr = OleSetClipboard(data->GetInterface());
500 if ( FAILED(hr) )
501 {
502 wxLogSysError(hr, _("Failed to put data on the clipboard"));
503
504 // don't free anything in this case
505
506 return FALSE;
507 }
508
509 // we have a problem here because we should delete wxDataObject, but we
510 // can't do it because IDataObject which we just gave to the clipboard
511 // would try to use it when it will need the data. IDataObject is ref
512 // counted and so doesn't suffer from such problem, so we release it now
513 // and tell it to delete wxDataObject when it is deleted itself.
514 data->SetAutoDelete();
515
516 // we have to call either OleSetClipboard(NULL) or OleFlushClipboard() when
517 // using OLE clipboard when the app terminates - by default, we call
518 // OleSetClipboard(NULL) which won't waste RAM, but the app can call
519 // wxClipboard::Flush() to chaneg this
520 m_clearOnExit = TRUE;
521
522 return TRUE;
523 #elif wxUSE_DATAOBJ
524 wxCHECK_MSG( wxIsClipboardOpened(), FALSE, wxT("clipboard not open") );
525
526 wxDataFormat format = data->GetFormat();
527
528 switch ( format )
529 {
530 case wxDF_TEXT:
531 case wxDF_OEMTEXT:
532 {
533 wxTextDataObject* textDataObject = (wxTextDataObject*) data;
534 wxString str(textDataObject->GetText());
535 return wxSetClipboardData(format, str.c_str());
536 }
537
538 case wxDF_BITMAP:
539 case wxDF_DIB:
540 {
541 wxBitmapDataObject* bitmapDataObject = (wxBitmapDataObject*) data;
542 wxBitmap bitmap(bitmapDataObject->GetBitmap());
543 return wxSetClipboardData(data->GetFormat(), &bitmap);
544 }
545
546 #if wxUSE_METAFILE
547 case wxDF_METAFILE:
548 {
549 wxMetafileDataObject* metaFileDataObject =
550 (wxMetafileDataObject*) data;
551 wxMetafile metaFile = metaFileDataObject->GetMetafile();
552 return wxSetClipboardData(wxDF_METAFILE, &metaFile,
553 metaFileDataObject->GetWidth(),
554 metaFileDataObject->GetHeight());
555 }
556 #endif // wxUSE_METAFILE
557
558 default:
559 return wxSetClipboardData(data);
560 }
561 #else // !wxUSE_DATAOBJ
562 return FALSE;
563 #endif // wxUSE_DATAOBJ/!wxUSE_DATAOBJ
564 }
565
566 void wxClipboard::Close()
567 {
568 // OLE closes clipboard for us
569 #if !wxUSE_OLE_CLIPBOARD
570 wxCloseClipboard();
571 #endif
572 }
573
574 bool wxClipboard::IsSupported( wxDataFormat format )
575 {
576 return wxIsClipboardFormatAvailable(format);
577 }
578
579 bool wxClipboard::GetData( wxDataObject& data )
580 {
581 #if wxUSE_OLE_CLIPBOARD
582 IDataObject *pDataObject = NULL;
583 HRESULT hr = OleGetClipboard(&pDataObject);
584 if ( FAILED(hr) || !pDataObject )
585 {
586 wxLogSysError(hr, _("Failed to get data from the clipboard"));
587
588 return FALSE;
589 }
590
591 // build the list of supported formats
592 size_t nFormats = data.GetFormatCount(wxDataObject::Set);
593 wxDataFormat format, *formats;
594 if ( nFormats == 1 )
595 {
596 // the most common case
597 formats = &format;
598 }
599 else
600 {
601 // bad luck, need to alloc mem
602 formats = new wxDataFormat[nFormats];
603 }
604
605 data.GetAllFormats(formats, wxDataObject::Set);
606
607 // get the format enumerator
608 bool result = FALSE;
609 wxArrayInt supportedFormats;
610 IEnumFORMATETC *pEnumFormatEtc = NULL;
611 hr = pDataObject->EnumFormatEtc(DATADIR_GET, &pEnumFormatEtc);
612 if ( FAILED(hr) || !pEnumFormatEtc )
613 {
614 wxLogSysError(hr,
615 _("Failed to retrieve the supported clipboard formats"));
616 }
617 else
618 {
619 // ask for the supported formats and see if there are any we support
620 FORMATETC formatEtc;
621 for ( ;; )
622 {
623 ULONG nCount;
624 hr = pEnumFormatEtc->Next(1, &formatEtc, &nCount);
625
626 // don't use FAILED() because S_FALSE would pass it
627 if ( hr != S_OK )
628 {
629 // no more formats
630 break;
631 }
632
633 CLIPFORMAT cf = formatEtc.cfFormat;
634
635 #ifdef __WXDEBUG__
636 wxLogTrace(wxTRACE_OleCalls,
637 wxT("Object on the clipboard supports format %s."),
638 wxDataObject::GetFormatName(cf));
639 #endif // Debug
640
641 // is supported?
642 for ( size_t n = 0; n < nFormats; n++ )
643 {
644 if ( formats[n].GetFormatId() == cf )
645 {
646 if ( supportedFormats.Index(cf) == wxNOT_FOUND )
647 {
648 supportedFormats.Add(cf);
649 }
650 }
651 }
652 }
653
654 pEnumFormatEtc->Release();
655 }
656
657 if ( formats != &format )
658 {
659 delete [] formats;
660 }
661 //else: we didn't allocate any memory
662
663 if ( !supportedFormats.IsEmpty() )
664 {
665 FORMATETC formatEtc;
666 formatEtc.ptd = NULL;
667 formatEtc.dwAspect = DVASPECT_CONTENT;
668 formatEtc.lindex = -1;
669 formatEtc.tymed = TYMED_HGLOBAL;
670
671 size_t nSupportedFormats = supportedFormats.GetCount();
672 for ( size_t n = 0; !result && (n < nSupportedFormats); n++ )
673 {
674 STGMEDIUM medium;
675 formatEtc.cfFormat = supportedFormats[n];
676
677 // try to get data
678 hr = pDataObject->GetData(&formatEtc, &medium);
679 if ( FAILED(hr) )
680 {
681 // try other tymed for GDI objects
682 if ( formatEtc.cfFormat == CF_BITMAP )
683 {
684 formatEtc.tymed = TYMED_HGLOBAL;
685 hr = pDataObject->GetData(&formatEtc, &medium);
686 }
687 }
688
689 if ( SUCCEEDED(hr) )
690 {
691 // pass the data to the data object
692 hr = data.GetInterface()->SetData(&formatEtc, &medium, TRUE);
693 if ( FAILED(hr) )
694 {
695 wxLogDebug(wxT("Failed to set data in wxIDataObject"));
696
697 // IDataObject only takes the ownership of data if it
698 // successfully got it - which is not the case here
699 ReleaseStgMedium(&medium);
700 }
701 else
702 {
703 result = TRUE;
704 }
705 }
706 //else: unsupported tymed?
707 }
708 }
709 //else: unsupported format
710
711 // clean up and return
712 pDataObject->Release();
713
714 return result;
715 #elif wxUSE_DATAOBJ
716 wxCHECK_MSG( wxIsClipboardOpened(), FALSE, wxT("clipboard not open") );
717
718 wxDataFormat format = data.GetFormat();
719 switch ( format )
720 {
721 case wxDF_TEXT:
722 case wxDF_OEMTEXT:
723 {
724 wxTextDataObject& textDataObject = (wxTextDataObject &)data;
725 char* s = (char*)wxGetClipboardData(format);
726 if ( !s )
727 return FALSE;
728
729 textDataObject.SetText(s);
730 delete [] s;
731
732 return TRUE;
733 }
734
735 case wxDF_BITMAP:
736 case wxDF_DIB:
737 {
738 wxBitmapDataObject& bitmapDataObject = (wxBitmapDataObject &)data;
739 wxBitmap* bitmap = (wxBitmap *)wxGetClipboardData(data->GetFormat());
740 if ( !bitmap )
741 return FALSE;
742
743 bitmapDataObject.SetBitmap(*bitmap);
744 delete bitmap;
745
746 return TRUE;
747 }
748 #if wxUSE_METAFILE
749 case wxDF_METAFILE:
750 {
751 wxMetafileDataObject& metaFileDataObject = (wxMetafileDataObject &)data;
752 wxMetafile* metaFile = (wxMetafile *)wxGetClipboardData(wxDF_METAFILE);
753 if ( !metaFile )
754 return FALSE;
755
756 metaFileDataObject.SetMetafile(*metaFile);
757 delete metaFile;
758
759 return TRUE;
760 }
761 #endif // wxUSE_METAFILE
762 }
763 #else // !wxUSE_DATAOBJ
764 wxFAIL_MSG( wxT("no clipboard implementation") );
765 #endif // wxUSE_OLE_CLIPBOARD/wxUSE_DATAOBJ
766
767 return FALSE;
768 }
769
770 #else
771 #error "Please turn wxUSE_CLIPBOARD on to compile this file."
772 #endif // wxUSE_CLIPBOARD
773