// Modified by:
// Created: 04/01/98
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart and Markus Holzem
-// Licence: wxWindows license
+// Copyright: (c) Julian Smart
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ===========================================================================
// headers
// ---------------------------------------------------------------------------
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma implementation "clipbrd.h"
#endif
#include "wx/clipbrd.h"
#include <string.h>
-#include <windows.h>
#include "wx/msw/private.h"
+
+#if wxUSE_WXDIB
#include "wx/msw/dib.h"
+#endif
-// wxDataObject is tied to OLE/drag and drop implementation,
-// therefore so is wxClipboard :-(
-#if wxUSE_DRAG_AND_DROP
- #include "wx/dataobj.h"
+// wxDataObject is tied to OLE/drag and drop implementation, therefore so are
+// the functions using wxDataObject in wxClipboard
+//#define wxUSE_DATAOBJ wxUSE_DRAG_AND_DROP
- static bool wxSetClipboardData(wxDataObject *data);
+#if wxUSE_DATAOBJ
+ #include "wx/dataobj.h"
#endif
-#ifdef __WIN16__
- #define memcpy hmemcpy
+#if wxUSE_OLE && !defined(__WXWINCE__)
+ // use OLE clipboard
+ #define wxUSE_OLE_CLIPBOARD 1
+#else // !wxUSE_DATAOBJ
+ // use Win clipboard API
+ #define wxUSE_OLE_CLIPBOARD 0
#endif
+#if wxUSE_OLE_CLIPBOARD
+ #include <ole2.h>
+#endif // wxUSE_OLE_CLIPBOARD
+
// ===========================================================================
// implementation
// ===========================================================================
bool wxIsClipboardFormatAvailable(wxDataFormat dataFormat)
{
- return ::IsClipboardFormatAvailable(dataFormat) != 0;
-}
+ wxDataFormat::NativeFormat cf = dataFormat.GetFormatId();
-#if wxUSE_DRAG_AND_DROP
-static bool wxSetClipboardData(wxDataObject *data)
-{
- wxDataFormat format = data->GetPreferredFormat();
- size_t size = data->GetDataSize(format);
- HANDLE hGlobal = ::GlobalAlloc(GMEM_MOVEABLE | GMEM_DDESHARE, size);
- if ( !hGlobal )
+ if ( ::IsClipboardFormatAvailable(cf) )
{
- wxLogSysError(_("Failed to allocate %dKb of memory for clipboard "
- "transfer."), size / 1024);
-
- return FALSE;
+ // ok from the first try
+ return TRUE;
}
- LPVOID lpGlobalMemory = ::GlobalLock(hGlobal);
-
- data->GetDataHere(format, lpGlobalMemory);
-
- GlobalUnlock(hGlobal);
-
- if ( !::SetClipboardData(format, hGlobal) )
+ // for several standard formats, we can convert from some other ones too
+ switch ( cf )
{
- wxLogSysError(_("Failed to set clipboard data in format %s"),
- wxDataObject::GetFormatName(format));
+ // for bitmaps, DIBs will also do
+ case CF_BITMAP:
+ return ::IsClipboardFormatAvailable(CF_DIB) != 0;
- return FALSE;
- }
+#if wxUSE_ENH_METAFILE && !defined(__WIN16__) && !defined(__WXWINCE__)
+ case CF_METAFILEPICT:
+ return ::IsClipboardFormatAvailable(CF_ENHMETAFILE) != 0;
+#endif // wxUSE_ENH_METAFILE
- return TRUE;
+ default:
+ return FALSE;
+ }
}
-#endif // wxUSE_DRAG_AND_DROP
+
bool wxSetClipboardData(wxDataFormat dataFormat,
const void *data,
break;
}
+#if wxUSE_WXDIB
case wxDF_DIB:
{
-#if wxUSE_IMAGE_LOADING_IN_MSW
wxBitmap *bitmap = (wxBitmap *)data;
- HBITMAP hBitmap = (HBITMAP)bitmap->GetHBITMAP();
- // NULL palette means to use the system one
- HANDLE hDIB = wxBitmapToDIB(hBitmap, (HPALETTE)NULL);
- handle = SetClipboardData(CF_DIB, hDIB);
-#endif
+
+ HGLOBAL hDIB = wxDIB::ConvertFromBitmap(GetHbitmapOf(*bitmap));
+ if ( hDIB )
+ {
+ handle = ::SetClipboardData(CF_DIB, hDIB);
+ }
break;
}
+#endif
-#if wxUSE_METAFILE
+ // VZ: I'm told that this code works, but it doesn't seem to work for me
+ // and, anyhow, I'd be highly surprised if it did. So I leave it here
+ // but IMNSHO it is completely broken.
+#if wxUSE_METAFILE && !defined(wxMETAFILE_IS_ENH) && !defined(__WXWINCE__)
case wxDF_METAFILE:
{
wxMetafile *wxMF = (wxMetafile *)data;
handle = SetClipboardData(CF_METAFILEPICT, data);
break;
}
-#endif
+#endif // wxUSE_METAFILE
+
+#if wxUSE_ENH_METAFILE && !defined(__WIN16__) && !defined(__WXWINCE__)
+ case wxDF_ENHMETAFILE:
+ {
+ wxEnhMetaFile *emf = (wxEnhMetaFile *)data;
+ wxEnhMetaFile emfCopy = *emf;
+
+ handle = SetClipboardData(CF_ENHMETAFILE,
+ (void *)emfCopy.GetHENHMETAFILE());
+ }
+ break;
+#endif // wxUSE_ENH_METAFILE
+
case CF_SYLK:
case CF_DIF:
case CF_TIFF:
handle = SetClipboardData(dataFormat, hGlobalMemory);
break;
}
+ // Only tested with non-Unicode, Visual C++ 6.0 so far
+#if defined(__VISUALC__) && !defined(UNICODE)
+ case wxDF_HTML:
+ {
+ char* html = (char *)data;
+
+ // Create temporary buffer for HTML header...
+ char *buf = new char [400 + strlen(html)];
+ if(!buf) return FALSE;
+
+ // Get clipboard id for HTML format...
+ static int cfid = 0;
+ if(!cfid) cfid = RegisterClipboardFormat(wxT("HTML Format"));
+
+ // Create a template string for the HTML header...
+ strcpy(buf,
+ "Version:0.9\r\n"
+ "StartHTML:00000000\r\n"
+ "EndHTML:00000000\r\n"
+ "StartFragment:00000000\r\n"
+ "EndFragment:00000000\r\n"
+ "<html><body>\r\n"
+ "<!--StartFragment -->\r\n");
+
+ // Append the HTML...
+ strcat(buf, html);
+ strcat(buf, "\r\n");
+ // Finish up the HTML format...
+ strcat(buf,
+ "<!--EndFragment-->\r\n"
+ "</body>\r\n"
+ "</html>");
+
+ // Now go back, calculate all the lengths, and write out the
+ // necessary header information. Note, wsprintf() truncates the
+ // string when you overwrite it so you follow up with code to replace
+ // the 0 appended at the end with a '\r'...
+ char *ptr = strstr(buf, "StartHTML");
+ wsprintf(ptr+10, "%08u", strstr(buf, "<html>") - buf);
+ *(ptr+10+8) = '\r';
+
+ ptr = strstr(buf, "EndHTML");
+ wsprintf(ptr+8, "%08u", strlen(buf));
+ *(ptr+8+8) = '\r';
+
+ ptr = strstr(buf, "StartFragment");
+ wsprintf(ptr+14, "%08u", strstr(buf, "<!--StartFrag") - buf);
+ *(ptr+14+8) = '\r';
+
+ ptr = strstr(buf, "EndFragment");
+ wsprintf(ptr+12, "%08u", strstr(buf, "<!--EndFrag") - buf);
+ *(ptr+12+8) = '\r';
+
+ // Now you have everything in place ready to put on the
+ // clipboard.
+
+ // Allocate global memory for transfer...
+ HGLOBAL hText = GlobalAlloc(GMEM_MOVEABLE |GMEM_DDESHARE, strlen(buf)+4);
+
+ // Put your string in the global memory...
+ ptr = (char *)GlobalLock(hText);
+ strcpy(ptr, buf);
+ GlobalUnlock(hText);
+
+ handle = ::SetClipboardData(cfid, hText);
+
+ // Free memory...
+ GlobalFree(hText);
+
+ // Clean up...
+ delete [] buf;
+ break;
+ }
+#endif
}
if ( handle == 0 )
switch ( dataFormat )
{
+#ifndef __WXWINCE__
case wxDF_BITMAP:
{
BITMAP bm;
wxBM->SetWidth(bm.bmWidth);
wxBM->SetHeight(bm.bmHeight);
wxBM->SetDepth(bm.bmPlanes);
- wxBM->SetOk(TRUE);
retval = wxBM;
break;
}
-
+#endif
case wxDF_METAFILE:
case CF_SYLK:
case CF_DIF:
case CF_TIFF:
case CF_PALETTE:
case wxDF_DIB:
- {
- wxLogError(_("Unsupported clipboard format."));
- return FALSE;
- }
+ wxLogError(_("Unsupported clipboard format."));
+ return NULL;
case wxDF_OEMTEXT:
dataFormat = wxDF_TEXT;
if (!s)
break;
- LPSTR lpGlobalMemory = (LPSTR)::GlobalLock(hGlobalMemory);
+ LPSTR lpGlobalMemory = (LPSTR) GlobalLock(hGlobalMemory);
memcpy(s, lpGlobalMemory, hsize);
- ::GlobalUnlock(hGlobalMemory);
+ GlobalUnlock(hGlobalMemory);
retval = s;
break;
if ( !buf )
break;
- LPSTR lpGlobalMemory = (LPSTR)::GlobalLock(hGlobalMemory);
+ LPSTR lpGlobalMemory = (LPSTR) GlobalLock(hGlobalMemory);
memcpy(buf, lpGlobalMemory, size);
- ::GlobalUnlock(hGlobalMemory);
+ GlobalUnlock(hGlobalMemory);
retval = buf;
break;
wxDataFormat wxEnumClipboardFormats(wxDataFormat dataFormat)
{
- return ::EnumClipboardFormats(dataFormat);
+ return (wxDataFormat::NativeFormat)::EnumClipboardFormats(dataFormat);
}
int wxRegisterClipboardFormat(wxChar *formatName)
IMPLEMENT_DYNAMIC_CLASS(wxClipboard, wxObject)
-wxClipboard* wxTheClipboard = (wxClipboard *)NULL;
-
wxClipboard::wxClipboard()
{
+ m_clearOnExit = FALSE;
+ m_isOpened = FALSE;
}
wxClipboard::~wxClipboard()
{
- Clear();
+ if ( m_clearOnExit )
+ {
+ Clear();
+ }
}
void wxClipboard::Clear()
{
+#if wxUSE_OLE_CLIPBOARD
+ if ( FAILED(OleSetClipboard(NULL)) )
+ {
+ wxLogLastError(wxT("OleSetClipboard(NULL)"));
+ }
+#endif
+}
+
+bool wxClipboard::Flush()
+{
+#if wxUSE_OLE_CLIPBOARD
+ if ( FAILED(OleFlushClipboard()) )
+ {
+ wxLogLastError(wxT("OleFlushClipboard"));
+
+ return FALSE;
+ }
+ else
+ {
+ m_clearOnExit = FALSE;
+
+ return TRUE;
+ }
+#else // !wxUSE_OLE_CLIPBOARD
+ return FALSE;
+#endif // wxUSE_OLE_CLIPBOARD/!wxUSE_OLE_CLIPBOARD
}
bool wxClipboard::Open()
{
+ // OLE opens clipboard for us
+ m_isOpened = TRUE;
+#if wxUSE_OLE_CLIPBOARD
+ return TRUE;
+#else
return wxOpenClipboard();
+#endif
+}
+
+bool wxClipboard::IsOpened() const
+{
+#if wxUSE_OLE_CLIPBOARD
+ return m_isOpened;
+#else
+ return wxIsClipboardOpened();
+#endif
}
bool wxClipboard::SetData( wxDataObject *data )
{
+#if !wxUSE_OLE_CLIPBOARD
(void)wxEmptyClipboard();
+#endif // wxUSE_OLE_CLIPBOARD
if ( data )
return AddData(data);
{
wxCHECK_MSG( data, FALSE, wxT("data is invalid") );
-#if wxUSE_DRAG_AND_DROP
+#if wxUSE_OLE_CLIPBOARD
+ HRESULT hr = OleSetClipboard(data->GetInterface());
+ if ( FAILED(hr) )
+ {
+ wxLogSysError(hr, _("Failed to put data on the clipboard"));
+
+ // don't free anything in this case
+
+ return FALSE;
+ }
+
+ // we have a problem here because we should delete wxDataObject, but we
+ // can't do it because IDataObject which we just gave to the clipboard
+ // would try to use it when it will need the data. IDataObject is ref
+ // counted and so doesn't suffer from such problem, so we release it now
+ // and tell it to delete wxDataObject when it is deleted itself.
+ data->SetAutoDelete();
+
+ // we have to call either OleSetClipboard(NULL) or OleFlushClipboard() when
+ // using OLE clipboard when the app terminates - by default, we call
+ // OleSetClipboard(NULL) which won't waste RAM, but the app can call
+ // wxClipboard::Flush() to chaneg this
+ m_clearOnExit = TRUE;
+
+ return TRUE;
+#elif wxUSE_DATAOBJ
wxCHECK_MSG( wxIsClipboardOpened(), FALSE, wxT("clipboard not open") );
- wxDataFormat format = data->GetFormat();
+ wxDataFormat format = data->GetPreferredFormat();
switch ( format )
{
{
wxBitmapDataObject* bitmapDataObject = (wxBitmapDataObject*) data;
wxBitmap bitmap(bitmapDataObject->GetBitmap());
- return wxSetClipboardData(data->GetFormat(), &bitmap);
+ return wxSetClipboardData(data->GetPreferredFormat(), &bitmap);
}
#if wxUSE_METAFILE
case wxDF_METAFILE:
{
- wxMetafileDataObject* metaFileDataObject =
+#if 1
+ // TODO
+ wxLogError("Not implemented because wxMetafileDataObject does not contain width and height values.");
+ return FALSE;
+#else
+ wxMetafileDataObject* metaFileDataObject =
(wxMetafileDataObject*) data;
wxMetafile metaFile = metaFileDataObject->GetMetafile();
return wxSetClipboardData(wxDF_METAFILE, &metaFile,
metaFileDataObject->GetWidth(),
metaFileDataObject->GetHeight());
+#endif
}
#endif // wxUSE_METAFILE
default:
- return wxSetClipboardData(data);
+ {
+// This didn't compile, of course
+// return wxSetClipboardData(data);
+ // TODO
+ wxLogError(wxT("Not implemented."));
+ return FALSE;
+ }
}
-#else // !wxUSE_DRAG_AND_DROP
+#else // !wxUSE_DATAOBJ
return FALSE;
-#endif // wxUSE_DRAG_AND_DROP/!wxUSE_DRAG_AND_DROP
+#endif // wxUSE_DATAOBJ/!wxUSE_DATAOBJ
}
void wxClipboard::Close()
{
+ m_isOpened = FALSE;
+ // OLE closes clipboard for us
+#if !wxUSE_OLE_CLIPBOARD
wxCloseClipboard();
+#endif
}
bool wxClipboard::IsSupported( wxDataFormat format )
return wxIsClipboardFormatAvailable(format);
}
-bool wxClipboard::GetData( wxDataObject *data )
+bool wxClipboard::GetData( wxDataObject& data )
{
- wxCHECK_MSG( wxIsClipboardOpened(), FALSE, wxT("clipboard not open") );
+#if wxUSE_OLE_CLIPBOARD
+ IDataObject *pDataObject = NULL;
+ HRESULT hr = OleGetClipboard(&pDataObject);
+ if ( FAILED(hr) || !pDataObject )
+ {
+ wxLogSysError(hr, _("Failed to get data from the clipboard"));
-#if wxUSE_DRAG_AND_DROP
- wxDataFormat format = data->GetFormat();
- switch ( format )
+ return FALSE;
+ }
+
+ // build the list of supported formats
+ size_t nFormats = data.GetFormatCount(wxDataObject::Set);
+ wxDataFormat format;
+ wxDataFormat *formats;
+ if ( nFormats == 1 )
{
- case wxDF_TEXT:
- case wxDF_OEMTEXT:
+ // the most common case
+ formats = &format;
+ }
+ else
+ {
+ // bad luck, need to alloc mem
+ formats = new wxDataFormat[nFormats];
+ }
+
+ data.GetAllFormats(formats, wxDataObject::Set);
+
+ // get the data for the given formats
+ FORMATETC formatEtc;
+ CLIPFORMAT cf;
+ bool result = FALSE;
+
+ // enumerate all explicit formats on the clipboard.
+ // note that this does not include implicit / synthetic (automatically
+ // converted) formats.
+#ifdef __WXDEBUG__
+ // get the format enumerator
+ IEnumFORMATETC *pEnumFormatEtc = NULL;
+ hr = pDataObject->EnumFormatEtc(DATADIR_GET, &pEnumFormatEtc);
+ if ( FAILED(hr) || !pEnumFormatEtc )
+ {
+ wxLogSysError(hr,
+ _("Failed to retrieve the supported clipboard formats"));
+ }
+ else
+ {
+ // ask for the supported formats and see if there are any we support
+ for ( ;; )
{
- wxTextDataObject* textDataObject = (wxTextDataObject*) data;
- char* s = (char*) wxGetClipboardData(format);
- if ( s )
+ ULONG nCount;
+ hr = pEnumFormatEtc->Next(1, &formatEtc, &nCount);
+
+ // don't use FAILED() because S_FALSE would pass it
+ if ( hr != S_OK )
{
- textDataObject->SetText(s);
- delete[] s;
- return TRUE;
+ // no more formats
+ break;
}
- else
- return FALSE;
+
+ cf = formatEtc.cfFormat;
+
+ wxLogTrace(wxTRACE_OleCalls,
+ wxT("Object on the clipboard supports format %s."),
+ wxDataObject::GetFormatName(cf));
}
- case wxDF_BITMAP:
- case wxDF_DIB:
+ pEnumFormatEtc->Release();
+ }
+#endif // Debug
+
+ STGMEDIUM medium;
+ // stop at the first valid format found on the clipboard
+ for ( size_t n = 0; !result && (n < nFormats); n++ )
+ {
+ // convert to NativeFormat Id
+ cf = formats[n].GetFormatId();
+
+ // if the format is not available, try the next one
+ // this test includes implicit / sythetic formats
+ if ( !::IsClipboardFormatAvailable(cf) )
+ continue;
+
+ formatEtc.cfFormat = cf;
+ formatEtc.ptd = NULL;
+ formatEtc.dwAspect = DVASPECT_CONTENT;
+ formatEtc.lindex = -1;
+
+ // use the appropriate tymed
+ switch ( formatEtc.cfFormat )
{
- wxBitmapDataObject* bitmapDataObject = (wxBitmapDataObject *)data;
- wxBitmap* bitmap = (wxBitmap *)wxGetClipboardData(data->GetFormat());
- if (bitmap)
+ case CF_BITMAP:
+ formatEtc.tymed = TYMED_GDI;
+ break;
+
+#ifndef __WXWINCE__
+ case CF_METAFILEPICT:
+ formatEtc.tymed = TYMED_MFPICT;
+ break;
+
+ case CF_ENHMETAFILE:
+ formatEtc.tymed = TYMED_ENHMF;
+ break;
+#endif
+
+ default:
+ formatEtc.tymed = TYMED_HGLOBAL;
+ }
+
+ // try to get data
+ hr = pDataObject->GetData(&formatEtc, &medium);
+ if ( FAILED(hr) )
+ {
+ // try other tymed for GDI objects
+ if ( formatEtc.cfFormat == CF_BITMAP )
{
- bitmapDataObject->SetBitmap(* bitmap);
- delete bitmap;
- return TRUE;
+ formatEtc.tymed = TYMED_HGLOBAL;
+ hr = pDataObject->GetData(&formatEtc, &medium);
}
- else
- return FALSE;
}
-#if wxUSE_METAFILE
- case wxDF_METAFILE:
+
+ if ( SUCCEEDED(hr) )
{
- wxMetafileDataObject* metaFileDataObject = (wxMetafileDataObject *)data;
- wxMetafile* metaFile = (wxMetafile *)wxGetClipboardData(wxDF_METAFILE);
- if (metaFile)
+ // pass the data to the data object
+ hr = data.GetInterface()->SetData(&formatEtc, &medium, TRUE);
+ if ( FAILED(hr) )
{
- metaFileDataObject->SetMetafile(*metaFile);
- delete metaFile;
- return TRUE;
+ wxLogDebug(wxT("Failed to set data in wxIDataObject"));
+
+ // IDataObject only takes the ownership of data if it
+ // successfully got it - which is not the case here
+ ReleaseStgMedium(&medium);
}
else
- return FALSE;
- }
-#endif
- default:
{
- long len;
- void *buf = wxGetClipboardData(format, &len);
- if ( buf )
- {
- // FIXME this is for testing only!!
- ((wxPrivateDataObject *)data)->SetData(buf, len);
- free(buf);
-
- return TRUE;
- }
+ result = TRUE;
}
+ }
+ //else: unsupported tymed?
+ }
- return FALSE;
+ if ( formats != &format )
+ {
+ delete [] formats;
}
-#else
- return FALSE;
-#endif
-}
+ //else: we didn't allocate any memory
-//-----------------------------------------------------------------------------
-// wxClipboardModule
-//-----------------------------------------------------------------------------
+ // clean up and return
+ pDataObject->Release();
-IMPLEMENT_DYNAMIC_CLASS(wxClipboardModule,wxModule)
+ return result;
+#elif wxUSE_DATAOBJ
+ wxCHECK_MSG( wxIsClipboardOpened(), FALSE, wxT("clipboard not open") );
-bool wxClipboardModule::OnInit()
-{
- wxTheClipboard = new wxClipboard();
+ wxDataFormat format = data.GetPreferredFormat();
+ switch ( format )
+ {
+ case wxDF_TEXT:
+ case wxDF_OEMTEXT:
+ {
+ wxTextDataObject& textDataObject = (wxTextDataObject &)data;
+ char* s = (char*)wxGetClipboardData(format);
+ if ( !s )
+ return FALSE;
- return TRUE;
-}
+ textDataObject.SetText(wxString::FromAscii(s));
+ delete [] s;
-void wxClipboardModule::OnExit()
-{
- if (wxTheClipboard) delete wxTheClipboard;
- wxTheClipboard = (wxClipboard*) NULL;
+ return TRUE;
+ }
+
+ case wxDF_BITMAP:
+ case wxDF_DIB:
+ {
+ wxBitmapDataObject& bitmapDataObject = (wxBitmapDataObject &)data;
+ wxBitmap* bitmap = (wxBitmap *)wxGetClipboardData(data.GetPreferredFormat());
+ if ( !bitmap )
+ return FALSE;
+
+ bitmapDataObject.SetBitmap(*bitmap);
+ delete bitmap;
+
+ return TRUE;
+ }
+#if wxUSE_METAFILE
+ case wxDF_METAFILE:
+ {
+ wxMetafileDataObject& metaFileDataObject = (wxMetafileDataObject &)data;
+ wxMetafile* metaFile = (wxMetafile *)wxGetClipboardData(wxDF_METAFILE);
+ if ( !metaFile )
+ return FALSE;
+
+ metaFileDataObject.SetMetafile(*metaFile);
+ delete metaFile;
+
+ return TRUE;
+ }
+#endif // wxUSE_METAFILE
+ }
+ return FALSE;
+#else // !wxUSE_DATAOBJ
+ wxFAIL_MSG( wxT("no clipboard implementation") );
+ return FALSE;
+#endif // wxUSE_OLE_CLIPBOARD/wxUSE_DATAOBJ
}
-#else
- #error "Please turn wxUSE_CLIPBOARD on to compile this file."
#endif // wxUSE_CLIPBOARD
projects / wxWidgets.git / blobdiff