]>
git.saurik.com Git - wxWidgets.git/blob - src/msw/clipbrd.cpp
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Clipboard functionality
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ===========================================================================
14 // ===========================================================================
16 // ---------------------------------------------------------------------------
18 // ---------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
30 #include "wx/object.h"
34 #include "wx/bitmap.h"
40 #include "wx/metafile.h"
44 #include "wx/clipbrd.h"
48 #include "wx/msw/private.h"
49 #include "wx/msw/ole/oleutils.h"
52 #include "wx/msw/dib.h"
55 // wxDataObject is tied to OLE/drag and drop implementation, therefore so are
56 // the functions using wxDataObject in wxClipboard
57 //#define wxUSE_DATAOBJ wxUSE_DRAG_AND_DROP
60 #include "wx/dataobj.h"
63 #if wxUSE_OLE && !defined(__WXWINCE__)
65 #define wxUSE_OLE_CLIPBOARD 1
66 #else // !wxUSE_DATAOBJ
67 // use Win clipboard API
68 #define wxUSE_OLE_CLIPBOARD 0
71 #if wxUSE_OLE_CLIPBOARD
73 #endif // wxUSE_OLE_CLIPBOARD
75 // ===========================================================================
77 // ===========================================================================
79 // ---------------------------------------------------------------------------
80 // old-style clipboard functions using Windows API
81 // ---------------------------------------------------------------------------
83 static bool gs_wxClipboardIsOpen
= false;
85 bool wxOpenClipboard()
87 wxCHECK_MSG( !gs_wxClipboardIsOpen
, true, wxT("clipboard already opened.") );
89 wxWindow
*win
= wxTheApp
->GetTopWindow();
92 gs_wxClipboardIsOpen
= ::OpenClipboard((HWND
)win
->GetHWND()) != 0;
94 if ( !gs_wxClipboardIsOpen
)
95 wxLogSysError(_("Failed to open the clipboard."));
97 return gs_wxClipboardIsOpen
;
101 wxLogDebug(wxT("Can not open clipboard without a main window."));
107 bool wxCloseClipboard()
109 wxCHECK_MSG( gs_wxClipboardIsOpen
, false, wxT("clipboard is not opened") );
111 gs_wxClipboardIsOpen
= false;
113 if ( ::CloseClipboard() == 0 )
115 wxLogSysError(_("Failed to close the clipboard."));
123 bool wxEmptyClipboard()
125 if ( ::EmptyClipboard() == 0 )
127 wxLogSysError(_("Failed to empty the clipboard."));
135 bool wxIsClipboardOpened()
137 return gs_wxClipboardIsOpen
;
140 bool wxIsClipboardFormatAvailable(wxDataFormat dataFormat
)
142 wxDataFormat::NativeFormat cf
= dataFormat
.GetFormatId();
144 if ( ::IsClipboardFormatAvailable(cf
) )
146 // ok from the first try
150 // for several standard formats, we can convert from some other ones too
153 // for bitmaps, DIBs will also do
155 return ::IsClipboardFormatAvailable(CF_DIB
) != 0;
157 #if wxUSE_ENH_METAFILE && !defined(__WXWINCE__)
158 case CF_METAFILEPICT
:
159 return ::IsClipboardFormatAvailable(CF_ENHMETAFILE
) != 0;
160 #endif // wxUSE_ENH_METAFILE
168 bool wxSetClipboardData(wxDataFormat dataFormat
,
170 int width
, int height
)
172 HANDLE handle
= 0; // return value of SetClipboardData
178 wxBitmap
*bitmap
= (wxBitmap
*)data
;
180 HDC hdcMem
= CreateCompatibleDC((HDC
) NULL
);
181 HDC hdcSrc
= CreateCompatibleDC((HDC
) NULL
);
182 HBITMAP old
= (HBITMAP
)
183 ::SelectObject(hdcSrc
, (HBITMAP
)bitmap
->GetHBITMAP());
184 HBITMAP hBitmap
= CreateCompatibleBitmap(hdcSrc
,
186 bitmap
->GetHeight());
189 SelectObject(hdcSrc
, old
);
195 HBITMAP old1
= (HBITMAP
) SelectObject(hdcMem
, hBitmap
);
196 BitBlt(hdcMem
, 0, 0, bitmap
->GetWidth(), bitmap
->GetHeight(),
197 hdcSrc
, 0, 0, SRCCOPY
);
199 // Select new bitmap out of memory DC
200 SelectObject(hdcMem
, old1
);
203 handle
= ::SetClipboardData(CF_BITMAP
, hBitmap
);
206 SelectObject(hdcSrc
, old
);
215 wxBitmap
*bitmap
= (wxBitmap
*)data
;
217 if ( bitmap
&& bitmap
->Ok() )
222 handle
= ::SetClipboardData(CF_DIB
, dib
.Detach());
229 // VZ: I'm told that this code works, but it doesn't seem to work for me
230 // and, anyhow, I'd be highly surprised if it did. So I leave it here
231 // but IMNSHO it is completely broken.
232 #if wxUSE_METAFILE && !defined(wxMETAFILE_IS_ENH) && !defined(__WXWINCE__)
235 wxMetafile
*wxMF
= (wxMetafile
*)data
;
236 HANDLE data
= GlobalAlloc(GHND
, sizeof(METAFILEPICT
) + 1);
237 METAFILEPICT
*mf
= (METAFILEPICT
*)GlobalLock(data
);
239 mf
->mm
= wxMF
->GetWindowsMappingMode();
242 mf
->hMF
= (HMETAFILE
) wxMF
->GetHMETAFILE();
244 wxMF
->SetHMETAFILE((WXHANDLE
) NULL
);
246 handle
= SetClipboardData(CF_METAFILEPICT
, data
);
249 #endif // wxUSE_METAFILE
251 #if wxUSE_ENH_METAFILE && !defined(__WXWINCE__)
252 case wxDF_ENHMETAFILE
:
254 wxEnhMetaFile
*emf
= (wxEnhMetaFile
*)data
;
255 wxEnhMetaFile emfCopy
= *emf
;
257 handle
= SetClipboardData(CF_ENHMETAFILE
,
258 (void *)emfCopy
.GetHENHMETAFILE());
261 #endif // wxUSE_ENH_METAFILE
269 wxLogError(_("Unsupported clipboard format."));
274 dataFormat
= wxDF_TEXT
;
279 char *s
= (char *)data
;
281 width
= strlen(s
) + 1;
283 DWORD l
= (width
* height
);
284 HANDLE hGlobalMemory
= GlobalAlloc(GHND
, l
);
287 LPSTR lpGlobalMemory
= (LPSTR
)GlobalLock(hGlobalMemory
);
289 memcpy(lpGlobalMemory
, s
, l
);
291 GlobalUnlock(hGlobalMemory
);
294 handle
= SetClipboardData(dataFormat
, hGlobalMemory
);
297 // Only tested with Visual C++ 6.0 so far
298 #if defined(__VISUALC__)
301 char* html
= (char *)data
;
303 // Create temporary buffer for HTML header...
304 char *buf
= new char [400 + strlen(html
)];
305 if(!buf
) return false;
307 // Get clipboard id for HTML format...
309 if(!cfid
) cfid
= RegisterClipboardFormat(wxT("HTML Format"));
311 // Create a template string for the HTML header...
314 "StartHTML:00000000\r\n"
315 "EndHTML:00000000\r\n"
316 "StartFragment:00000000\r\n"
317 "EndFragment:00000000\r\n"
319 "<!--StartFragment -->\r\n");
321 // Append the HTML...
324 // Finish up the HTML format...
326 "<!--EndFragment-->\r\n"
330 // Now go back, calculate all the lengths, and write out the
331 // necessary header information. Note, wsprintf() truncates the
332 // string when you overwrite it so you follow up with code to replace
333 // the 0 appended at the end with a '\r'...
334 char *ptr
= strstr(buf
, "StartHTML");
335 sprintf(ptr
+10, "%08u", strstr(buf
, "<html>") - buf
);
338 ptr
= strstr(buf
, "EndHTML");
339 sprintf(ptr
+8, "%08u", strlen(buf
));
342 ptr
= strstr(buf
, "StartFragment");
343 sprintf(ptr
+14, "%08u", strstr(buf
, "<!--StartFrag") - buf
);
346 ptr
= strstr(buf
, "EndFragment");
347 sprintf(ptr
+12, "%08u", strstr(buf
, "<!--EndFrag") - buf
);
350 // Now you have everything in place ready to put on the
353 // Allocate global memory for transfer...
354 HGLOBAL hText
= GlobalAlloc(GMEM_MOVEABLE
|GMEM_DDESHARE
, strlen(buf
)+4);
356 // Put your string in the global memory...
357 ptr
= (char *)GlobalLock(hText
);
361 handle
= ::SetClipboardData(cfid
, hText
);
375 wxLogSysError(_("Failed to set clipboard data."));
383 void *wxGetClipboardData(wxDataFormat dataFormat
, long *len
)
387 switch ( dataFormat
)
393 HBITMAP hBitmap
= (HBITMAP
) GetClipboardData(CF_BITMAP
);
397 HDC hdcMem
= CreateCompatibleDC((HDC
) NULL
);
398 HDC hdcSrc
= CreateCompatibleDC((HDC
) NULL
);
400 HBITMAP old
= (HBITMAP
) ::SelectObject(hdcSrc
, hBitmap
);
401 GetObject(hBitmap
, sizeof(BITMAP
), (LPSTR
)&bm
);
403 HBITMAP hNewBitmap
= CreateBitmapIndirect(&bm
);
407 SelectObject(hdcSrc
, old
);
413 HBITMAP old1
= (HBITMAP
) SelectObject(hdcMem
, hNewBitmap
);
414 BitBlt(hdcMem
, 0, 0, bm
.bmWidth
, bm
.bmHeight
,
415 hdcSrc
, 0, 0, SRCCOPY
);
417 // Select new bitmap out of memory DC
418 SelectObject(hdcMem
, old1
);
421 SelectObject(hdcSrc
, old
);
425 // Create and return a new wxBitmap
426 wxBitmap
*wxBM
= new wxBitmap
;
427 wxBM
->SetHBITMAP((WXHBITMAP
) hNewBitmap
);
428 wxBM
->SetWidth(bm
.bmWidth
);
429 wxBM
->SetHeight(bm
.bmHeight
);
430 wxBM
->SetDepth(bm
.bmPlanes
);
441 wxLogError(_("Unsupported clipboard format."));
445 dataFormat
= wxDF_TEXT
;
450 HANDLE hGlobalMemory
= ::GetClipboardData(dataFormat
);
454 DWORD hsize
= ::GlobalSize(hGlobalMemory
);
458 char *s
= new char[hsize
];
462 LPSTR lpGlobalMemory
= (LPSTR
) GlobalLock(hGlobalMemory
);
464 memcpy(s
, lpGlobalMemory
, hsize
);
466 GlobalUnlock(hGlobalMemory
);
474 HANDLE hGlobalMemory
= ::GetClipboardData(dataFormat
);
475 if ( !hGlobalMemory
)
478 DWORD size
= ::GlobalSize(hGlobalMemory
);
482 void *buf
= malloc(size
);
486 LPSTR lpGlobalMemory
= (LPSTR
) GlobalLock(hGlobalMemory
);
488 memcpy(buf
, lpGlobalMemory
, size
);
490 GlobalUnlock(hGlobalMemory
);
499 wxLogSysError(_("Failed to retrieve data from the clipboard."));
505 wxDataFormat
wxEnumClipboardFormats(wxDataFormat dataFormat
)
507 return (wxDataFormat::NativeFormat
)::EnumClipboardFormats(dataFormat
);
510 int wxRegisterClipboardFormat(wxChar
*formatName
)
512 return ::RegisterClipboardFormat(formatName
);
515 bool wxGetClipboardFormatName(wxDataFormat dataFormat
,
519 return ::GetClipboardFormatName((int)dataFormat
, formatName
, maxCount
) > 0;
522 // ---------------------------------------------------------------------------
524 // ---------------------------------------------------------------------------
526 IMPLEMENT_DYNAMIC_CLASS(wxClipboard
, wxObject
)
528 wxClipboard::wxClipboard()
530 #if wxUSE_OLE_CLIPBOARD
534 m_clearOnExit
= false;
538 wxClipboard::~wxClipboard()
545 #if wxUSE_OLE_CLIPBOARD
550 void wxClipboard::Clear()
552 #if wxUSE_OLE_CLIPBOARD
553 HRESULT hr
= OleSetClipboard(NULL
);
556 wxLogApiError(wxT("OleSetClipboard(NULL)"), hr
);
558 #endif // wxUSE_OLE_CLIPBOARD
561 bool wxClipboard::Flush()
563 #if wxUSE_OLE_CLIPBOARD
564 HRESULT hr
= OleFlushClipboard();
567 wxLogApiError(wxT("OleFlushClipboard"), hr
);
573 m_clearOnExit
= false;
577 #else // !wxUSE_OLE_CLIPBOARD
579 #endif // wxUSE_OLE_CLIPBOARD/!wxUSE_OLE_CLIPBOARD
582 bool wxClipboard::Open()
584 // OLE opens clipboard for us
586 #if wxUSE_OLE_CLIPBOARD
589 return wxOpenClipboard();
593 bool wxClipboard::IsOpened() const
595 #if wxUSE_OLE_CLIPBOARD
598 return wxIsClipboardOpened();
602 bool wxClipboard::SetData( wxDataObject
*data
)
604 #if !wxUSE_OLE_CLIPBOARD
605 (void)wxEmptyClipboard();
606 #endif // wxUSE_OLE_CLIPBOARD
609 return AddData(data
);
614 bool wxClipboard::AddData( wxDataObject
*data
)
616 wxCHECK_MSG( data
, false, wxT("data is invalid") );
618 #if wxUSE_OLE_CLIPBOARD
619 HRESULT hr
= OleSetClipboard(data
->GetInterface());
622 wxLogSysError(hr
, _("Failed to put data on the clipboard"));
624 // don't free anything in this case
629 // we have a problem here because we should delete wxDataObject, but we
630 // can't do it because IDataObject which we just gave to the clipboard
631 // would try to use it when it will need the data. IDataObject is ref
632 // counted and so doesn't suffer from such problem, so we release it now
633 // and tell it to delete wxDataObject when it is deleted itself.
634 data
->SetAutoDelete();
636 // we have to call either OleSetClipboard(NULL) or OleFlushClipboard() when
637 // using OLE clipboard when the app terminates - by default, we call
638 // OleSetClipboard(NULL) which won't waste RAM, but the app can call
639 // wxClipboard::Flush() to chaneg this
640 m_clearOnExit
= true;
644 wxCHECK_MSG( wxIsClipboardOpened(), false, wxT("clipboard not open") );
646 wxDataFormat format
= data
->GetPreferredFormat();
653 wxTextDataObject
* textDataObject
= (wxTextDataObject
*) data
;
654 wxString
str(textDataObject
->GetText());
655 return wxSetClipboardData(format
, str
.c_str());
661 wxBitmapDataObject
* bitmapDataObject
= (wxBitmapDataObject
*) data
;
662 wxBitmap
bitmap(bitmapDataObject
->GetBitmap());
663 return wxSetClipboardData(data
->GetPreferredFormat(), &bitmap
);
671 wxLogError(wxT("Not implemented because wxMetafileDataObject does not contain width and height values."));
674 wxMetafileDataObject
* metaFileDataObject
=
675 (wxMetafileDataObject
*) data
;
676 wxMetafile metaFile
= metaFileDataObject
->GetMetafile();
677 return wxSetClipboardData(wxDF_METAFILE
, &metaFile
,
678 metaFileDataObject
->GetWidth(),
679 metaFileDataObject
->GetHeight());
682 #endif // wxUSE_METAFILE
686 // This didn't compile, of course
687 // return wxSetClipboardData(data);
689 wxLogError(wxT("Not implemented."));
693 #else // !wxUSE_DATAOBJ
695 #endif // wxUSE_DATAOBJ/!wxUSE_DATAOBJ
698 void wxClipboard::Close()
701 // OLE closes clipboard for us
702 #if !wxUSE_OLE_CLIPBOARD
707 bool wxClipboard::IsSupported( const wxDataFormat
& format
)
709 return wxIsClipboardFormatAvailable(format
);
712 bool wxClipboard::GetData( wxDataObject
& data
)
714 #if wxUSE_OLE_CLIPBOARD
715 IDataObject
*pDataObject
= NULL
;
716 HRESULT hr
= OleGetClipboard(&pDataObject
);
717 if ( FAILED(hr
) || !pDataObject
)
719 wxLogSysError(hr
, _("Failed to get data from the clipboard"));
724 // build the list of supported formats
725 size_t nFormats
= data
.GetFormatCount(wxDataObject::Set
);
727 wxDataFormat
*formats
;
730 // the most common case
735 // bad luck, need to alloc mem
736 formats
= new wxDataFormat
[nFormats
];
739 data
.GetAllFormats(formats
, wxDataObject::Set
);
741 // get the data for the given formats
746 // enumerate all explicit formats on the clipboard.
747 // note that this does not include implicit / synthetic (automatically
748 // converted) formats.
750 // get the format enumerator
751 IEnumFORMATETC
*pEnumFormatEtc
= NULL
;
752 hr
= pDataObject
->EnumFormatEtc(DATADIR_GET
, &pEnumFormatEtc
);
753 if ( FAILED(hr
) || !pEnumFormatEtc
)
756 _("Failed to retrieve the supported clipboard formats"));
760 // ask for the supported formats and see if there are any we support
764 hr
= pEnumFormatEtc
->Next(1, &formatEtc
, &nCount
);
766 // don't use FAILED() because S_FALSE would pass it
773 cf
= formatEtc
.cfFormat
;
775 wxLogTrace(wxTRACE_OleCalls
,
776 wxT("Object on the clipboard supports format %s."),
777 wxDataObject::GetFormatName(cf
));
780 pEnumFormatEtc
->Release();
785 // stop at the first valid format found on the clipboard
786 for ( size_t n
= 0; !result
&& (n
< nFormats
); n
++ )
788 // convert to NativeFormat Id
789 cf
= formats
[n
].GetFormatId();
791 // if the format is not available, try the next one
792 // this test includes implicit / sythetic formats
793 if ( !::IsClipboardFormatAvailable(cf
) )
796 formatEtc
.cfFormat
= cf
;
797 formatEtc
.ptd
= NULL
;
798 formatEtc
.dwAspect
= DVASPECT_CONTENT
;
799 formatEtc
.lindex
= -1;
801 // use the appropriate tymed
802 switch ( formatEtc
.cfFormat
)
805 formatEtc
.tymed
= TYMED_GDI
;
809 case CF_METAFILEPICT
:
810 formatEtc
.tymed
= TYMED_MFPICT
;
814 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 if ( formats
!= &format
)
858 //else: we didn't allocate any memory
860 // clean up and return
861 pDataObject
->Release();
865 wxCHECK_MSG( wxIsClipboardOpened(), false, wxT("clipboard not open") );
867 wxDataFormat format
= data
.GetPreferredFormat();
873 wxTextDataObject
& textDataObject
= (wxTextDataObject
&)data
;
874 char* s
= (char*)wxGetClipboardData(format
);
878 textDataObject
.SetText(wxString::FromAscii(s
));
887 wxBitmapDataObject
& bitmapDataObject
= (wxBitmapDataObject
&)data
;
888 wxBitmap
* bitmap
= (wxBitmap
*)wxGetClipboardData(data
.GetPreferredFormat());
892 bitmapDataObject
.SetBitmap(*bitmap
);
900 wxMetafileDataObject
& metaFileDataObject
= (wxMetafileDataObject
&)data
;
901 wxMetafile
* metaFile
= (wxMetafile
*)wxGetClipboardData(wxDF_METAFILE
);
905 metaFileDataObject
.SetMetafile(*metaFile
);
910 #endif // wxUSE_METAFILE
913 #else // !wxUSE_DATAOBJ
914 wxFAIL_MSG( wxT("no clipboard implementation") );
916 #endif // wxUSE_OLE_CLIPBOARD/wxUSE_DATAOBJ
919 #endif // wxUSE_CLIPBOARD