1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Clipboard functionality
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ===========================================================================
14 // ===========================================================================
16 // ---------------------------------------------------------------------------
18 // ---------------------------------------------------------------------------
21 #pragma implementation "clipbrd.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
38 #include "wx/object.h"
42 #include "wx/bitmap.h"
48 #include "wx/metafile.h"
52 #include "wx/clipbrd.h"
57 #include "wx/msw/private.h"
59 #ifndef __WXMICROWIN__
60 #include "wx/msw/dib.h"
63 // wxDataObject is tied to OLE/drag and drop implementation, therefore so are
64 // the functions using wxDataObject in wxClipboard
65 //#define wxUSE_DATAOBJ wxUSE_DRAG_AND_DROP
68 #include "wx/dataobj.h"
73 #define wxUSE_OLE_CLIPBOARD 1
74 #else // !wxUSE_DATAOBJ
75 // use Win clipboard API
76 #define wxUSE_OLE_CLIPBOARD 0
79 #if wxUSE_OLE_CLIPBOARD
81 #endif // wxUSE_OLE_CLIPBOARD
84 #define memcpy hmemcpy
87 // ===========================================================================
89 // ===========================================================================
91 // ---------------------------------------------------------------------------
92 // old-style clipboard functions using Windows API
93 // ---------------------------------------------------------------------------
95 static bool gs_wxClipboardIsOpen
= FALSE
;
97 bool wxOpenClipboard()
99 wxCHECK_MSG( !gs_wxClipboardIsOpen
, TRUE
, wxT("clipboard already opened.") );
101 wxWindow
*win
= wxTheApp
->GetTopWindow();
104 gs_wxClipboardIsOpen
= ::OpenClipboard((HWND
)win
->GetHWND()) != 0;
106 if ( !gs_wxClipboardIsOpen
)
107 wxLogSysError(_("Failed to open the clipboard."));
109 return gs_wxClipboardIsOpen
;
113 wxLogDebug(wxT("Can not open clipboard without a main window."));
119 bool wxCloseClipboard()
121 wxCHECK_MSG( gs_wxClipboardIsOpen
, FALSE
, wxT("clipboard is not opened") );
123 gs_wxClipboardIsOpen
= FALSE
;
125 if ( ::CloseClipboard() == 0 )
127 wxLogSysError(_("Failed to close the clipboard."));
135 bool wxEmptyClipboard()
137 if ( ::EmptyClipboard() == 0 )
139 wxLogSysError(_("Failed to empty the clipboard."));
147 bool wxIsClipboardOpened()
149 return gs_wxClipboardIsOpen
;
152 bool wxIsClipboardFormatAvailable(wxDataFormat dataFormat
)
154 if ( ::IsClipboardFormatAvailable(dataFormat
) )
156 // ok from the first try
160 // for several standard formats, we can convert from some other ones too
161 switch ( dataFormat
.GetFormatId() )
163 // for bitmaps, DIBs will also do
165 return ::IsClipboardFormatAvailable(CF_DIB
) != 0;
167 #if wxUSE_ENH_METAFILE && !defined(__WIN16__)
168 case CF_METAFILEPICT
:
169 return ::IsClipboardFormatAvailable(CF_ENHMETAFILE
) != 0;
170 #endif // wxUSE_ENH_METAFILE
177 bool wxSetClipboardData(wxDataFormat dataFormat
,
179 int width
, int height
)
181 HANDLE handle
= 0; // return value of SetClipboardData
187 wxBitmap
*bitmap
= (wxBitmap
*)data
;
189 HDC hdcMem
= CreateCompatibleDC((HDC
) NULL
);
190 HDC hdcSrc
= CreateCompatibleDC((HDC
) NULL
);
191 HBITMAP old
= (HBITMAP
)
192 ::SelectObject(hdcSrc
, (HBITMAP
)bitmap
->GetHBITMAP());
193 HBITMAP hBitmap
= CreateCompatibleBitmap(hdcSrc
,
195 bitmap
->GetHeight());
198 SelectObject(hdcSrc
, old
);
204 HBITMAP old1
= (HBITMAP
) SelectObject(hdcMem
, hBitmap
);
205 BitBlt(hdcMem
, 0, 0, bitmap
->GetWidth(), bitmap
->GetHeight(),
206 hdcSrc
, 0, 0, SRCCOPY
);
208 // Select new bitmap out of memory DC
209 SelectObject(hdcMem
, old1
);
212 handle
= ::SetClipboardData(CF_BITMAP
, hBitmap
);
215 SelectObject(hdcSrc
, old
);
223 #if wxUSE_IMAGE_LOADING_IN_MSW
224 wxBitmap
*bitmap
= (wxBitmap
*)data
;
225 HBITMAP hBitmap
= (HBITMAP
)bitmap
->GetHBITMAP();
226 // NULL palette means to use the system one
227 HANDLE hDIB
= wxBitmapToDIB(hBitmap
, (HPALETTE
)NULL
);
228 handle
= SetClipboardData(CF_DIB
, hDIB
);
229 #endif // wxUSE_IMAGE_LOADING_IN_MSW
233 // VZ: I'm told that this code works, but it doesn't seem to work for me
234 // and, anyhow, I'd be highly surprized if it did. So I leave it here
235 // but IMNSHO it is completely broken.
236 #if wxUSE_METAFILE && !defined(wxMETAFILE_IS_ENH)
239 wxMetafile
*wxMF
= (wxMetafile
*)data
;
240 HANDLE data
= GlobalAlloc(GHND
, sizeof(METAFILEPICT
) + 1);
241 METAFILEPICT
*mf
= (METAFILEPICT
*)GlobalLock(data
);
243 mf
->mm
= wxMF
->GetWindowsMappingMode();
246 mf
->hMF
= (HMETAFILE
) wxMF
->GetHMETAFILE();
248 wxMF
->SetHMETAFILE((WXHANDLE
) NULL
);
250 handle
= SetClipboardData(CF_METAFILEPICT
, data
);
253 #endif // wxUSE_METAFILE
255 #if wxUSE_ENH_METAFILE && !defined(__WIN16__)
256 case wxDF_ENHMETAFILE
:
258 wxEnhMetaFile
*emf
= (wxEnhMetaFile
*)data
;
259 wxEnhMetaFile emfCopy
= *emf
;
261 handle
= SetClipboardData(CF_ENHMETAFILE
,
262 (void *)emfCopy
.GetHENHMETAFILE());
265 #endif // wxUSE_ENH_METAFILE
273 wxLogError(_("Unsupported clipboard format."));
278 dataFormat
= wxDF_TEXT
;
283 char *s
= (char *)data
;
285 width
= strlen(s
) + 1;
287 DWORD l
= (width
* height
);
288 HANDLE hGlobalMemory
= GlobalAlloc(GHND
, l
);
291 LPSTR lpGlobalMemory
= (LPSTR
)GlobalLock(hGlobalMemory
);
293 memcpy(lpGlobalMemory
, s
, l
);
295 GlobalUnlock(hGlobalMemory
);
298 handle
= SetClipboardData(dataFormat
, hGlobalMemory
);
301 // Only tested with non-Unicode, Visual C++ 6.0 so far
302 #if defined(__VISUALC__) && !defined(UNICODE)
305 char* html
= (char *)data
;
307 // Create temporary buffer for HTML header...
308 char *buf
= new char [400 + strlen(html
)];
309 if(!buf
) return FALSE
;
311 // Get clipboard id for HTML format...
313 if(!cfid
) cfid
= RegisterClipboardFormat(wxT("HTML Format"));
315 // Create a template string for the HTML header...
318 "StartHTML:00000000\r\n"
319 "EndHTML:00000000\r\n"
320 "StartFragment:00000000\r\n"
321 "EndFragment:00000000\r\n"
323 "<!--StartFragment -->\r\n");
325 // Append the HTML...
328 // Finish up the HTML format...
330 "<!--EndFragment-->\r\n"
334 // Now go back, calculate all the lengths, and write out the
335 // necessary header information. Note, wsprintf() truncates the
336 // string when you overwrite it so you follow up with code to replace
337 // the 0 appended at the end with a '\r'...
338 char *ptr
= strstr(buf
, "StartHTML");
339 wsprintf(ptr
+10, "%08u", strstr(buf
, "<html>") - buf
);
342 ptr
= strstr(buf
, "EndHTML");
343 wsprintf(ptr
+8, "%08u", strlen(buf
));
346 ptr
= strstr(buf
, "StartFragment");
347 wsprintf(ptr
+14, "%08u", strstr(buf
, "<!--StartFrag") - buf
);
350 ptr
= strstr(buf
, "EndFragment");
351 wsprintf(ptr
+12, "%08u", strstr(buf
, "<!--EndFrag") - buf
);
354 // Now you have everything in place ready to put on the
357 // Allocate global memory for transfer...
358 HGLOBAL hText
= GlobalAlloc(GMEM_MOVEABLE
|GMEM_DDESHARE
, strlen(buf
)+4);
360 // Put your string in the global memory...
361 ptr
= (char *)GlobalLock(hText
);
365 handle
= ::SetClipboardData(cfid
, hText
);
379 wxLogSysError(_("Failed to set clipboard data."));
387 void *wxGetClipboardData(wxDataFormat dataFormat
, long *len
)
391 switch ( dataFormat
)
396 HBITMAP hBitmap
= (HBITMAP
) GetClipboardData(CF_BITMAP
);
400 HDC hdcMem
= CreateCompatibleDC((HDC
) NULL
);
401 HDC hdcSrc
= CreateCompatibleDC((HDC
) NULL
);
403 HBITMAP old
= (HBITMAP
) ::SelectObject(hdcSrc
, hBitmap
);
404 GetObject(hBitmap
, sizeof(BITMAP
), (LPSTR
)&bm
);
406 HBITMAP hNewBitmap
= CreateBitmapIndirect(&bm
);
410 SelectObject(hdcSrc
, old
);
416 HBITMAP old1
= (HBITMAP
) SelectObject(hdcMem
, hNewBitmap
);
417 BitBlt(hdcMem
, 0, 0, bm
.bmWidth
, bm
.bmHeight
,
418 hdcSrc
, 0, 0, SRCCOPY
);
420 // Select new bitmap out of memory DC
421 SelectObject(hdcMem
, old1
);
424 SelectObject(hdcSrc
, old
);
428 // Create and return a new wxBitmap
429 wxBitmap
*wxBM
= new wxBitmap
;
430 wxBM
->SetHBITMAP((WXHBITMAP
) hNewBitmap
);
431 wxBM
->SetWidth(bm
.bmWidth
);
432 wxBM
->SetHeight(bm
.bmHeight
);
433 wxBM
->SetDepth(bm
.bmPlanes
);
434 #if WXWIN_COMPATIBILITY_2
436 #endif // WXWIN_COMPATIBILITY_2
447 wxLogError(_("Unsupported clipboard format."));
451 dataFormat
= wxDF_TEXT
;
456 HANDLE hGlobalMemory
= ::GetClipboardData(dataFormat
);
460 DWORD hsize
= ::GlobalSize(hGlobalMemory
);
464 char *s
= new char[hsize
];
468 LPSTR lpGlobalMemory
= (LPSTR
)::GlobalLock(hGlobalMemory
);
470 memcpy(s
, lpGlobalMemory
, hsize
);
472 ::GlobalUnlock(hGlobalMemory
);
480 HANDLE hGlobalMemory
= ::GetClipboardData(dataFormat
);
481 if ( !hGlobalMemory
)
484 DWORD size
= ::GlobalSize(hGlobalMemory
);
488 void *buf
= malloc(size
);
492 LPSTR lpGlobalMemory
= (LPSTR
)::GlobalLock(hGlobalMemory
);
494 memcpy(buf
, lpGlobalMemory
, size
);
496 ::GlobalUnlock(hGlobalMemory
);
505 wxLogSysError(_("Failed to retrieve data from the clipboard."));
511 wxDataFormat
wxEnumClipboardFormats(wxDataFormat dataFormat
)
513 return (wxDataFormat::NativeFormat
)::EnumClipboardFormats(dataFormat
);
516 int wxRegisterClipboardFormat(wxChar
*formatName
)
518 return ::RegisterClipboardFormat(formatName
);
521 bool wxGetClipboardFormatName(wxDataFormat dataFormat
,
525 return ::GetClipboardFormatName((int)dataFormat
, formatName
, maxCount
) > 0;
528 // ---------------------------------------------------------------------------
530 // ---------------------------------------------------------------------------
532 IMPLEMENT_DYNAMIC_CLASS(wxClipboard
, wxObject
)
534 wxClipboard::wxClipboard()
536 m_clearOnExit
= FALSE
;
539 wxClipboard::~wxClipboard()
547 void wxClipboard::Clear()
549 #if wxUSE_OLE_CLIPBOARD
550 if ( FAILED(OleSetClipboard(NULL
)) )
552 wxLogLastError(wxT("OleSetClipboard(NULL)"));
557 bool wxClipboard::Flush()
559 #if wxUSE_OLE_CLIPBOARD
560 if ( FAILED(OleFlushClipboard()) )
562 wxLogLastError(wxT("OleFlushClipboard"));
568 m_clearOnExit
= FALSE
;
572 #else // !wxUSE_OLE_CLIPBOARD
574 #endif // wxUSE_OLE_CLIPBOARD/!wxUSE_OLE_CLIPBOARD
577 bool wxClipboard::Open()
579 // OLE opens clipboard for us
580 #if wxUSE_OLE_CLIPBOARD
583 return wxOpenClipboard();
587 bool wxClipboard::IsOpened() const
589 #if wxUSE_OLE_CLIPBOARD
592 return wxIsClipboardOpened();
596 bool wxClipboard::SetData( wxDataObject
*data
)
598 #if !wxUSE_OLE_CLIPBOARD
599 (void)wxEmptyClipboard();
600 #endif // wxUSE_OLE_CLIPBOARD
603 return AddData(data
);
608 bool wxClipboard::AddData( wxDataObject
*data
)
610 wxCHECK_MSG( data
, FALSE
, wxT("data is invalid") );
612 #if wxUSE_OLE_CLIPBOARD
613 HRESULT hr
= OleSetClipboard(data
->GetInterface());
616 wxLogSysError(hr
, _("Failed to put data on the clipboard"));
618 // don't free anything in this case
623 // we have a problem here because we should delete wxDataObject, but we
624 // can't do it because IDataObject which we just gave to the clipboard
625 // would try to use it when it will need the data. IDataObject is ref
626 // counted and so doesn't suffer from such problem, so we release it now
627 // and tell it to delete wxDataObject when it is deleted itself.
628 data
->SetAutoDelete();
630 // we have to call either OleSetClipboard(NULL) or OleFlushClipboard() when
631 // using OLE clipboard when the app terminates - by default, we call
632 // OleSetClipboard(NULL) which won't waste RAM, but the app can call
633 // wxClipboard::Flush() to chaneg this
634 m_clearOnExit
= TRUE
;
638 wxCHECK_MSG( wxIsClipboardOpened(), FALSE
, wxT("clipboard not open") );
640 wxDataFormat format
= data
->GetPreferredFormat();
647 wxTextDataObject
* textDataObject
= (wxTextDataObject
*) data
;
648 wxString
str(textDataObject
->GetText());
649 return wxSetClipboardData(format
, str
.c_str());
655 wxBitmapDataObject
* bitmapDataObject
= (wxBitmapDataObject
*) data
;
656 wxBitmap
bitmap(bitmapDataObject
->GetBitmap());
657 return wxSetClipboardData(data
->GetPreferredFormat(), &bitmap
);
665 wxLogError("Not implemented because wxMetafileDataObject does not contain width and height values.");
668 wxMetafileDataObject
* metaFileDataObject
=
669 (wxMetafileDataObject
*) data
;
670 wxMetafile metaFile
= metaFileDataObject
->GetMetafile();
671 return wxSetClipboardData(wxDF_METAFILE
, &metaFile
,
672 metaFileDataObject
->GetWidth(),
673 metaFileDataObject
->GetHeight());
676 #endif // wxUSE_METAFILE
680 // This didn't compile, of course
681 // return wxSetClipboardData(data);
683 wxLogError("Not implemented.");
687 #else // !wxUSE_DATAOBJ
689 #endif // wxUSE_DATAOBJ/!wxUSE_DATAOBJ
692 void wxClipboard::Close()
694 // OLE closes clipboard for us
695 #if !wxUSE_OLE_CLIPBOARD
700 bool wxClipboard::IsSupported( wxDataFormat format
)
702 return wxIsClipboardFormatAvailable(format
);
705 bool wxClipboard::GetData( wxDataObject
& data
)
707 #if wxUSE_OLE_CLIPBOARD
708 IDataObject
*pDataObject
= NULL
;
709 HRESULT hr
= OleGetClipboard(&pDataObject
);
710 if ( FAILED(hr
) || !pDataObject
)
712 wxLogSysError(hr
, _("Failed to get data from the clipboard"));
717 // build the list of supported formats
718 size_t nFormats
= data
.GetFormatCount(wxDataObject::Set
);
720 wxDataFormat
*formats
;
723 // the most common case
728 // bad luck, need to alloc mem
729 formats
= new wxDataFormat
[nFormats
];
732 data
.GetAllFormats(formats
, wxDataObject::Set
);
734 // get the format enumerator
736 wxArrayInt supportedFormats
;
737 IEnumFORMATETC
*pEnumFormatEtc
= NULL
;
738 hr
= pDataObject
->EnumFormatEtc(DATADIR_GET
, &pEnumFormatEtc
);
739 if ( FAILED(hr
) || !pEnumFormatEtc
)
742 _("Failed to retrieve the supported clipboard formats"));
746 // ask for the supported formats and see if there are any we support
751 hr
= pEnumFormatEtc
->Next(1, &formatEtc
, &nCount
);
753 // don't use FAILED() because S_FALSE would pass it
760 CLIPFORMAT cf
= formatEtc
.cfFormat
;
763 wxLogTrace(wxTRACE_OleCalls
,
764 wxT("Object on the clipboard supports format %s."),
765 wxDataObject::GetFormatName(cf
));
769 for ( size_t n
= 0; n
< nFormats
; n
++ )
771 if ( formats
[n
].GetFormatId() == cf
)
773 if ( supportedFormats
.Index(cf
) == wxNOT_FOUND
)
775 supportedFormats
.Add(cf
);
781 pEnumFormatEtc
->Release();
784 if ( formats
!= &format
)
788 //else: we didn't allocate any memory
790 if ( !supportedFormats
.IsEmpty() )
793 formatEtc
.ptd
= NULL
;
794 formatEtc
.dwAspect
= DVASPECT_CONTENT
;
795 formatEtc
.lindex
= -1;
797 size_t nSupportedFormats
= supportedFormats
.GetCount();
798 for ( size_t n
= 0; !result
&& (n
< nSupportedFormats
); n
++ )
801 formatEtc
.cfFormat
= supportedFormats
[n
];
803 // use the appropriate tymed
804 switch ( formatEtc
.cfFormat
)
807 formatEtc
.tymed
= TYMED_GDI
;
810 case CF_METAFILEPICT
:
811 formatEtc
.tymed
= TYMED_MFPICT
;
815 formatEtc
.tymed
= TYMED_ENHMF
;
819 formatEtc
.tymed
= TYMED_HGLOBAL
;
823 hr
= pDataObject
->GetData(&formatEtc
, &medium
);
826 // try other tymed for GDI objects
827 if ( formatEtc
.cfFormat
== CF_BITMAP
)
829 formatEtc
.tymed
= TYMED_HGLOBAL
;
830 hr
= pDataObject
->GetData(&formatEtc
, &medium
);
836 // pass the data to the data object
837 hr
= data
.GetInterface()->SetData(&formatEtc
, &medium
, TRUE
);
840 wxLogDebug(wxT("Failed to set data in wxIDataObject"));
842 // IDataObject only takes the ownership of data if it
843 // successfully got it - which is not the case here
844 ReleaseStgMedium(&medium
);
851 //else: unsupported tymed?
854 //else: unsupported format
856 // clean up and return
857 pDataObject
->Release();
861 wxCHECK_MSG( wxIsClipboardOpened(), FALSE
, wxT("clipboard not open") );
863 wxDataFormat format
= data
.GetPreferredFormat();
869 wxTextDataObject
& textDataObject
= (wxTextDataObject
&)data
;
870 char* s
= (char*)wxGetClipboardData(format
);
874 textDataObject
.SetText(s
);
883 wxBitmapDataObject
& bitmapDataObject
= (wxBitmapDataObject
&)data
;
884 wxBitmap
* bitmap
= (wxBitmap
*)wxGetClipboardData(data
.GetPreferredFormat());
888 bitmapDataObject
.SetBitmap(*bitmap
);
896 wxMetafileDataObject
& metaFileDataObject
= (wxMetafileDataObject
&)data
;
897 wxMetafile
* metaFile
= (wxMetafile
*)wxGetClipboardData(wxDF_METAFILE
);
901 metaFileDataObject
.SetMetafile(*metaFile
);
906 #endif // wxUSE_METAFILE
909 #else // !wxUSE_DATAOBJ
910 wxFAIL_MSG( wxT("no clipboard implementation") );
912 #endif // wxUSE_OLE_CLIPBOARD/wxUSE_DATAOBJ
915 #endif // wxUSE_CLIPBOARD