1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Clipboard functionality
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ===========================================================================
14 // ===========================================================================
16 // ---------------------------------------------------------------------------
18 // ---------------------------------------------------------------------------
20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
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"
56 #include "wx/msw/private.h"
59 #include "wx/msw/dib.h"
62 // wxDataObject is tied to OLE/drag and drop implementation, therefore so are
63 // the functions using wxDataObject in wxClipboard
64 //#define wxUSE_DATAOBJ wxUSE_DRAG_AND_DROP
67 #include "wx/dataobj.h"
70 #if wxUSE_OLE && !defined(__WXWINCE__)
72 #define wxUSE_OLE_CLIPBOARD 1
73 #else // !wxUSE_DATAOBJ
74 // use Win clipboard API
75 #define wxUSE_OLE_CLIPBOARD 0
78 #if wxUSE_OLE_CLIPBOARD
80 #endif // wxUSE_OLE_CLIPBOARD
82 // ===========================================================================
84 // ===========================================================================
86 // ---------------------------------------------------------------------------
87 // old-style clipboard functions using Windows API
88 // ---------------------------------------------------------------------------
90 static bool gs_wxClipboardIsOpen
= FALSE
;
92 bool wxOpenClipboard()
94 wxCHECK_MSG( !gs_wxClipboardIsOpen
, TRUE
, wxT("clipboard already opened.") );
96 wxWindow
*win
= wxTheApp
->GetTopWindow();
99 gs_wxClipboardIsOpen
= ::OpenClipboard((HWND
)win
->GetHWND()) != 0;
101 if ( !gs_wxClipboardIsOpen
)
102 wxLogSysError(_("Failed to open the clipboard."));
104 return gs_wxClipboardIsOpen
;
108 wxLogDebug(wxT("Can not open clipboard without a main window."));
114 bool wxCloseClipboard()
116 wxCHECK_MSG( gs_wxClipboardIsOpen
, FALSE
, wxT("clipboard is not opened") );
118 gs_wxClipboardIsOpen
= FALSE
;
120 if ( ::CloseClipboard() == 0 )
122 wxLogSysError(_("Failed to close the clipboard."));
130 bool wxEmptyClipboard()
132 if ( ::EmptyClipboard() == 0 )
134 wxLogSysError(_("Failed to empty the clipboard."));
142 bool wxIsClipboardOpened()
144 return gs_wxClipboardIsOpen
;
147 bool wxIsClipboardFormatAvailable(wxDataFormat dataFormat
)
149 if ( ::IsClipboardFormatAvailable(dataFormat
) )
151 // ok from the first try
155 // for several standard formats, we can convert from some other ones too
156 switch ( dataFormat
.GetFormatId() )
158 // for bitmaps, DIBs will also do
160 return ::IsClipboardFormatAvailable(CF_DIB
) != 0;
162 #if wxUSE_ENH_METAFILE && !defined(__WIN16__) && !defined(__WXWINCE__)
163 case CF_METAFILEPICT
:
164 return ::IsClipboardFormatAvailable(CF_ENHMETAFILE
) != 0;
165 #endif // wxUSE_ENH_METAFILE
173 bool wxSetClipboardData(wxDataFormat dataFormat
,
175 int width
, int height
)
177 HANDLE handle
= 0; // return value of SetClipboardData
183 wxBitmap
*bitmap
= (wxBitmap
*)data
;
185 HDC hdcMem
= CreateCompatibleDC((HDC
) NULL
);
186 HDC hdcSrc
= CreateCompatibleDC((HDC
) NULL
);
187 HBITMAP old
= (HBITMAP
)
188 ::SelectObject(hdcSrc
, (HBITMAP
)bitmap
->GetHBITMAP());
189 HBITMAP hBitmap
= CreateCompatibleBitmap(hdcSrc
,
191 bitmap
->GetHeight());
194 SelectObject(hdcSrc
, old
);
200 HBITMAP old1
= (HBITMAP
) SelectObject(hdcMem
, hBitmap
);
201 BitBlt(hdcMem
, 0, 0, bitmap
->GetWidth(), bitmap
->GetHeight(),
202 hdcSrc
, 0, 0, SRCCOPY
);
204 // Select new bitmap out of memory DC
205 SelectObject(hdcMem
, old1
);
208 handle
= ::SetClipboardData(CF_BITMAP
, hBitmap
);
211 SelectObject(hdcSrc
, old
);
220 wxBitmap
*bitmap
= (wxBitmap
*)data
;
222 HGLOBAL hDIB
= wxDIB::ConvertFromBitmap(GetHbitmapOf(*bitmap
));
225 handle
= ::SetClipboardData(CF_DIB
, hDIB
);
231 // VZ: I'm told that this code works, but it doesn't seem to work for me
232 // and, anyhow, I'd be highly surprised if it did. So I leave it here
233 // but IMNSHO it is completely broken.
234 #if wxUSE_METAFILE && !defined(wxMETAFILE_IS_ENH) && !defined(__WXWINCE__)
237 wxMetafile
*wxMF
= (wxMetafile
*)data
;
238 HANDLE data
= GlobalAlloc(GHND
, sizeof(METAFILEPICT
) + 1);
239 METAFILEPICT
*mf
= (METAFILEPICT
*)GlobalLock(data
);
241 mf
->mm
= wxMF
->GetWindowsMappingMode();
244 mf
->hMF
= (HMETAFILE
) wxMF
->GetHMETAFILE();
246 wxMF
->SetHMETAFILE((WXHANDLE
) NULL
);
248 handle
= SetClipboardData(CF_METAFILEPICT
, data
);
251 #endif // wxUSE_METAFILE
253 #if wxUSE_ENH_METAFILE && !defined(__WIN16__) && !defined(__WXWINCE__)
254 case wxDF_ENHMETAFILE
:
256 wxEnhMetaFile
*emf
= (wxEnhMetaFile
*)data
;
257 wxEnhMetaFile emfCopy
= *emf
;
259 handle
= SetClipboardData(CF_ENHMETAFILE
,
260 (void *)emfCopy
.GetHENHMETAFILE());
263 #endif // wxUSE_ENH_METAFILE
271 wxLogError(_("Unsupported clipboard format."));
276 dataFormat
= wxDF_TEXT
;
281 char *s
= (char *)data
;
283 width
= strlen(s
) + 1;
285 DWORD l
= (width
* height
);
286 HANDLE hGlobalMemory
= GlobalAlloc(GHND
, l
);
289 LPSTR lpGlobalMemory
= (LPSTR
)GlobalLock(hGlobalMemory
);
291 memcpy(lpGlobalMemory
, s
, l
);
293 GlobalUnlock(hGlobalMemory
);
296 handle
= SetClipboardData(dataFormat
, hGlobalMemory
);
299 // Only tested with non-Unicode, Visual C++ 6.0 so far
300 #if defined(__VISUALC__) && !defined(UNICODE)
303 char* html
= (char *)data
;
305 // Create temporary buffer for HTML header...
306 char *buf
= new char [400 + strlen(html
)];
307 if(!buf
) return FALSE
;
309 // Get clipboard id for HTML format...
311 if(!cfid
) cfid
= RegisterClipboardFormat(wxT("HTML Format"));
313 // Create a template string for the HTML header...
316 "StartHTML:00000000\r\n"
317 "EndHTML:00000000\r\n"
318 "StartFragment:00000000\r\n"
319 "EndFragment:00000000\r\n"
321 "<!--StartFragment -->\r\n");
323 // Append the HTML...
326 // Finish up the HTML format...
328 "<!--EndFragment-->\r\n"
332 // Now go back, calculate all the lengths, and write out the
333 // necessary header information. Note, wsprintf() truncates the
334 // string when you overwrite it so you follow up with code to replace
335 // the 0 appended at the end with a '\r'...
336 char *ptr
= strstr(buf
, "StartHTML");
337 wsprintf(ptr
+10, "%08u", strstr(buf
, "<html>") - buf
);
340 ptr
= strstr(buf
, "EndHTML");
341 wsprintf(ptr
+8, "%08u", strlen(buf
));
344 ptr
= strstr(buf
, "StartFragment");
345 wsprintf(ptr
+14, "%08u", strstr(buf
, "<!--StartFrag") - buf
);
348 ptr
= strstr(buf
, "EndFragment");
349 wsprintf(ptr
+12, "%08u", strstr(buf
, "<!--EndFrag") - buf
);
352 // Now you have everything in place ready to put on the
355 // Allocate global memory for transfer...
356 HGLOBAL hText
= GlobalAlloc(GMEM_MOVEABLE
|GMEM_DDESHARE
, strlen(buf
)+4);
358 // Put your string in the global memory...
359 ptr
= (char *)GlobalLock(hText
);
363 handle
= ::SetClipboardData(cfid
, hText
);
377 wxLogSysError(_("Failed to set clipboard data."));
385 void *wxGetClipboardData(wxDataFormat dataFormat
, long *len
)
389 switch ( dataFormat
)
395 HBITMAP hBitmap
= (HBITMAP
) GetClipboardData(CF_BITMAP
);
399 HDC hdcMem
= CreateCompatibleDC((HDC
) NULL
);
400 HDC hdcSrc
= CreateCompatibleDC((HDC
) NULL
);
402 HBITMAP old
= (HBITMAP
) ::SelectObject(hdcSrc
, hBitmap
);
403 GetObject(hBitmap
, sizeof(BITMAP
), (LPSTR
)&bm
);
405 HBITMAP hNewBitmap
= CreateBitmapIndirect(&bm
);
409 SelectObject(hdcSrc
, old
);
415 HBITMAP old1
= (HBITMAP
) SelectObject(hdcMem
, hNewBitmap
);
416 BitBlt(hdcMem
, 0, 0, bm
.bmWidth
, bm
.bmHeight
,
417 hdcSrc
, 0, 0, SRCCOPY
);
419 // Select new bitmap out of memory DC
420 SelectObject(hdcMem
, old1
);
423 SelectObject(hdcSrc
, old
);
427 // Create and return a new wxBitmap
428 wxBitmap
*wxBM
= new wxBitmap
;
429 wxBM
->SetHBITMAP((WXHBITMAP
) hNewBitmap
);
430 wxBM
->SetWidth(bm
.bmWidth
);
431 wxBM
->SetHeight(bm
.bmHeight
);
432 wxBM
->SetDepth(bm
.bmPlanes
);
443 wxLogError(_("Unsupported clipboard format."));
447 dataFormat
= wxDF_TEXT
;
452 HANDLE hGlobalMemory
= ::GetClipboardData(dataFormat
);
456 DWORD hsize
= ::GlobalSize(hGlobalMemory
);
460 char *s
= new char[hsize
];
464 LPSTR lpGlobalMemory
= (LPSTR
) GlobalLock(hGlobalMemory
);
466 memcpy(s
, lpGlobalMemory
, hsize
);
468 GlobalUnlock(hGlobalMemory
);
476 HANDLE hGlobalMemory
= ::GetClipboardData(dataFormat
);
477 if ( !hGlobalMemory
)
480 DWORD size
= ::GlobalSize(hGlobalMemory
);
484 void *buf
= malloc(size
);
488 LPSTR lpGlobalMemory
= (LPSTR
) GlobalLock(hGlobalMemory
);
490 memcpy(buf
, lpGlobalMemory
, size
);
492 GlobalUnlock(hGlobalMemory
);
501 wxLogSysError(_("Failed to retrieve data from the clipboard."));
507 wxDataFormat
wxEnumClipboardFormats(wxDataFormat dataFormat
)
509 return (wxDataFormat::NativeFormat
)::EnumClipboardFormats(dataFormat
);
512 int wxRegisterClipboardFormat(wxChar
*formatName
)
514 return ::RegisterClipboardFormat(formatName
);
517 bool wxGetClipboardFormatName(wxDataFormat dataFormat
,
521 return ::GetClipboardFormatName((int)dataFormat
, formatName
, maxCount
) > 0;
524 // ---------------------------------------------------------------------------
526 // ---------------------------------------------------------------------------
528 IMPLEMENT_DYNAMIC_CLASS(wxClipboard
, wxObject
)
530 wxClipboard::wxClipboard()
532 m_clearOnExit
= FALSE
;
536 wxClipboard::~wxClipboard()
544 void wxClipboard::Clear()
546 #if wxUSE_OLE_CLIPBOARD
547 if ( FAILED(OleSetClipboard(NULL
)) )
549 wxLogLastError(wxT("OleSetClipboard(NULL)"));
554 bool wxClipboard::Flush()
556 #if wxUSE_OLE_CLIPBOARD
557 if ( FAILED(OleFlushClipboard()) )
559 wxLogLastError(wxT("OleFlushClipboard"));
565 m_clearOnExit
= FALSE
;
569 #else // !wxUSE_OLE_CLIPBOARD
571 #endif // wxUSE_OLE_CLIPBOARD/!wxUSE_OLE_CLIPBOARD
574 bool wxClipboard::Open()
576 // OLE opens clipboard for us
578 #if wxUSE_OLE_CLIPBOARD
581 return wxOpenClipboard();
585 bool wxClipboard::IsOpened() const
587 #if wxUSE_OLE_CLIPBOARD
590 return wxIsClipboardOpened();
594 bool wxClipboard::SetData( wxDataObject
*data
)
596 #if !wxUSE_OLE_CLIPBOARD
597 (void)wxEmptyClipboard();
598 #endif // wxUSE_OLE_CLIPBOARD
601 return AddData(data
);
606 bool wxClipboard::AddData( wxDataObject
*data
)
608 wxCHECK_MSG( data
, FALSE
, wxT("data is invalid") );
610 #if wxUSE_OLE_CLIPBOARD
611 HRESULT hr
= OleSetClipboard(data
->GetInterface());
614 wxLogSysError(hr
, _("Failed to put data on the clipboard"));
616 // don't free anything in this case
621 // we have a problem here because we should delete wxDataObject, but we
622 // can't do it because IDataObject which we just gave to the clipboard
623 // would try to use it when it will need the data. IDataObject is ref
624 // counted and so doesn't suffer from such problem, so we release it now
625 // and tell it to delete wxDataObject when it is deleted itself.
626 data
->SetAutoDelete();
628 // we have to call either OleSetClipboard(NULL) or OleFlushClipboard() when
629 // using OLE clipboard when the app terminates - by default, we call
630 // OleSetClipboard(NULL) which won't waste RAM, but the app can call
631 // wxClipboard::Flush() to chaneg this
632 m_clearOnExit
= TRUE
;
636 wxCHECK_MSG( wxIsClipboardOpened(), FALSE
, wxT("clipboard not open") );
638 wxDataFormat format
= data
->GetPreferredFormat();
645 wxTextDataObject
* textDataObject
= (wxTextDataObject
*) data
;
646 wxString
str(textDataObject
->GetText());
647 return wxSetClipboardData(format
, str
.c_str());
653 wxBitmapDataObject
* bitmapDataObject
= (wxBitmapDataObject
*) data
;
654 wxBitmap
bitmap(bitmapDataObject
->GetBitmap());
655 return wxSetClipboardData(data
->GetPreferredFormat(), &bitmap
);
663 wxLogError("Not implemented because wxMetafileDataObject does not contain width and height values.");
666 wxMetafileDataObject
* metaFileDataObject
=
667 (wxMetafileDataObject
*) data
;
668 wxMetafile metaFile
= metaFileDataObject
->GetMetafile();
669 return wxSetClipboardData(wxDF_METAFILE
, &metaFile
,
670 metaFileDataObject
->GetWidth(),
671 metaFileDataObject
->GetHeight());
674 #endif // wxUSE_METAFILE
678 // This didn't compile, of course
679 // return wxSetClipboardData(data);
681 wxLogError(wxT("Not implemented."));
685 #else // !wxUSE_DATAOBJ
687 #endif // wxUSE_DATAOBJ/!wxUSE_DATAOBJ
690 void wxClipboard::Close()
693 // OLE closes clipboard for us
694 #if !wxUSE_OLE_CLIPBOARD
699 bool wxClipboard::IsSupported( wxDataFormat format
)
701 return wxIsClipboardFormatAvailable(format
);
704 bool wxClipboard::GetData( wxDataObject
& data
)
706 #if wxUSE_OLE_CLIPBOARD
707 IDataObject
*pDataObject
= NULL
;
708 HRESULT hr
= OleGetClipboard(&pDataObject
);
709 if ( FAILED(hr
) || !pDataObject
)
711 wxLogSysError(hr
, _("Failed to get data from the clipboard"));
716 // build the list of supported formats
717 size_t nFormats
= data
.GetFormatCount(wxDataObject::Set
);
719 wxDataFormat
*formats
;
722 // the most common case
727 // bad luck, need to alloc mem
728 formats
= new wxDataFormat
[nFormats
];
731 data
.GetAllFormats(formats
, wxDataObject::Set
);
733 // get the format enumerator
735 wxArrayInt supportedFormats
;
736 IEnumFORMATETC
*pEnumFormatEtc
= NULL
;
737 hr
= pDataObject
->EnumFormatEtc(DATADIR_GET
, &pEnumFormatEtc
);
738 if ( FAILED(hr
) || !pEnumFormatEtc
)
741 _("Failed to retrieve the supported clipboard formats"));
745 // ask for the supported formats and see if there are any we support
750 hr
= pEnumFormatEtc
->Next(1, &formatEtc
, &nCount
);
752 // don't use FAILED() because S_FALSE would pass it
759 CLIPFORMAT cf
= formatEtc
.cfFormat
;
762 wxLogTrace(wxTRACE_OleCalls
,
763 wxT("Object on the clipboard supports format %s."),
764 wxDataObject::GetFormatName(cf
));
768 for ( size_t n
= 0; n
< nFormats
; n
++ )
770 if ( formats
[n
].GetFormatId() == cf
)
772 if ( supportedFormats
.Index(cf
) == wxNOT_FOUND
)
774 supportedFormats
.Add(cf
);
780 pEnumFormatEtc
->Release();
783 if ( formats
!= &format
)
787 //else: we didn't allocate any memory
789 if ( !supportedFormats
.IsEmpty() )
792 formatEtc
.ptd
= NULL
;
793 formatEtc
.dwAspect
= DVASPECT_CONTENT
;
794 formatEtc
.lindex
= -1;
796 size_t nSupportedFormats
= supportedFormats
.GetCount();
797 for ( size_t n
= 0; !result
&& (n
< nSupportedFormats
); n
++ )
800 formatEtc
.cfFormat
= supportedFormats
[n
];
802 // use the appropriate tymed
803 switch ( formatEtc
.cfFormat
)
806 formatEtc
.tymed
= TYMED_GDI
;
809 case CF_METAFILEPICT
:
810 formatEtc
.tymed
= TYMED_MFPICT
;
814 formatEtc
.tymed
= TYMED_ENHMF
;
818 formatEtc
.tymed
= TYMED_HGLOBAL
;
822 hr
= pDataObject
->GetData(&formatEtc
, &medium
);
825 // try other tymed for GDI objects
826 if ( formatEtc
.cfFormat
== CF_BITMAP
)
828 formatEtc
.tymed
= TYMED_HGLOBAL
;
829 hr
= pDataObject
->GetData(&formatEtc
, &medium
);
835 // pass the data to the data object
836 hr
= data
.GetInterface()->SetData(&formatEtc
, &medium
, TRUE
);
839 wxLogDebug(wxT("Failed to set data in wxIDataObject"));
841 // IDataObject only takes the ownership of data if it
842 // successfully got it - which is not the case here
843 ReleaseStgMedium(&medium
);
850 //else: unsupported tymed?
853 //else: unsupported format
855 // clean up and return
856 pDataObject
->Release();
860 wxCHECK_MSG( wxIsClipboardOpened(), FALSE
, wxT("clipboard not open") );
862 wxDataFormat format
= data
.GetPreferredFormat();
868 wxTextDataObject
& textDataObject
= (wxTextDataObject
&)data
;
869 char* s
= (char*)wxGetClipboardData(format
);
873 textDataObject
.SetText(wxString::FromAscii(s
));
882 wxBitmapDataObject
& bitmapDataObject
= (wxBitmapDataObject
&)data
;
883 wxBitmap
* bitmap
= (wxBitmap
*)wxGetClipboardData(data
.GetPreferredFormat());
887 bitmapDataObject
.SetBitmap(*bitmap
);
895 wxMetafileDataObject
& metaFileDataObject
= (wxMetafileDataObject
&)data
;
896 wxMetafile
* metaFile
= (wxMetafile
*)wxGetClipboardData(wxDF_METAFILE
);
900 metaFileDataObject
.SetMetafile(*metaFile
);
905 #endif // wxUSE_METAFILE
908 #else // !wxUSE_DATAOBJ
909 wxFAIL_MSG( wxT("no clipboard implementation") );
911 #endif // wxUSE_OLE_CLIPBOARD/wxUSE_DATAOBJ
914 #endif // wxUSE_CLIPBOARD