/////////////////////////////////////////////////////////////////////////////
-// Name: clipbrd.cpp
+// Name: src/msw/clipbrd.cpp
// Purpose: Clipboard functionality
// Author: Julian Smart
// Modified by:
// headers
// ---------------------------------------------------------------------------
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #pragma implementation "clipbrd.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#pragma hdrstop
#endif
-#ifndef WX_PRECOMP
- #include "wx/setup.h"
-#endif
-
#if wxUSE_CLIPBOARD
+#include "wx/clipbrd.h"
+
#ifndef WX_PRECOMP
#include "wx/object.h"
#include "wx/event.h"
#include "wx/bitmap.h"
#include "wx/utils.h"
#include "wx/intl.h"
+ #include "wx/log.h"
+ #include "wx/dataobj.h"
#endif
#if wxUSE_METAFILE
#include "wx/metafile.h"
#endif
-#include "wx/log.h"
-#include "wx/clipbrd.h"
#include <string.h>
#include "wx/msw/private.h"
+#include "wx/msw/ole/oleutils.h"
#if wxUSE_WXDIB
-#include "wx/msw/dib.h"
+ #include "wx/msw/dib.h"
#endif
// 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
-#if wxUSE_DATAOBJ
- #include "wx/dataobj.h"
-#endif
-
#if wxUSE_OLE && !defined(__WXWINCE__)
// use OLE clipboard
#define wxUSE_OLE_CLIPBOARD 1
// old-style clipboard functions using Windows API
// ---------------------------------------------------------------------------
-static bool gs_wxClipboardIsOpen = FALSE;
+static bool gs_wxClipboardIsOpen = false;
bool wxOpenClipboard()
{
- wxCHECK_MSG( !gs_wxClipboardIsOpen, TRUE, wxT("clipboard already opened.") );
+ wxCHECK_MSG( !gs_wxClipboardIsOpen, true, wxT("clipboard already opened.") );
wxWindow *win = wxTheApp->GetTopWindow();
if ( win )
{
wxLogDebug(wxT("Can not open clipboard without a main window."));
- return FALSE;
+ return false;
}
}
bool wxCloseClipboard()
{
- wxCHECK_MSG( gs_wxClipboardIsOpen, FALSE, wxT("clipboard is not opened") );
+ wxCHECK_MSG( gs_wxClipboardIsOpen, false, wxT("clipboard is not opened") );
- gs_wxClipboardIsOpen = FALSE;
+ gs_wxClipboardIsOpen = false;
if ( ::CloseClipboard() == 0 )
{
wxLogSysError(_("Failed to close the clipboard."));
- return FALSE;
+ return false;
}
- return TRUE;
+ return true;
}
bool wxEmptyClipboard()
{
wxLogSysError(_("Failed to empty the clipboard."));
- return FALSE;
+ return false;
}
- return TRUE;
+ return true;
}
bool wxIsClipboardOpened()
bool wxIsClipboardFormatAvailable(wxDataFormat dataFormat)
{
- if ( ::IsClipboardFormatAvailable(dataFormat) )
+ wxDataFormat::NativeFormat cf = dataFormat.GetFormatId();
+
+ if ( ::IsClipboardFormatAvailable(cf) )
{
// ok from the first try
- return TRUE;
+ return true;
}
// for several standard formats, we can convert from some other ones too
- switch ( dataFormat.GetFormatId() )
+ switch ( cf )
{
// for bitmaps, DIBs will also do
case CF_BITMAP:
return ::IsClipboardFormatAvailable(CF_DIB) != 0;
-#if wxUSE_ENH_METAFILE && !defined(__WIN16__) && !defined(__WXWINCE__)
+#if wxUSE_ENH_METAFILE && !defined(__WXWINCE__)
case CF_METAFILEPICT:
return ::IsClipboardFormatAvailable(CF_ENHMETAFILE) != 0;
#endif // wxUSE_ENH_METAFILE
default:
- return FALSE;
+ return false;
}
}
SelectObject(hdcSrc, old);
DeleteDC(hdcMem);
DeleteDC(hdcSrc);
- return FALSE;
+ return false;
}
HBITMAP old1 = (HBITMAP) SelectObject(hdcMem, hBitmap);
{
wxBitmap *bitmap = (wxBitmap *)data;
- HGLOBAL hDIB = wxDIB::ConvertFromBitmap(GetHbitmapOf(*bitmap));
- if ( hDIB )
+ if ( bitmap && bitmap->Ok() )
{
- handle = ::SetClipboardData(CF_DIB, hDIB);
+ wxDIB dib(*bitmap);
+ if ( dib.IsOk() )
+ {
+ handle = ::SetClipboardData(CF_DIB, dib.Detach());
+ }
}
break;
}
}
#endif // wxUSE_METAFILE
-#if wxUSE_ENH_METAFILE && !defined(__WIN16__) && !defined(__WXWINCE__)
+#if wxUSE_ENH_METAFILE && !defined(__WXWINCE__)
case wxDF_ENHMETAFILE:
{
wxEnhMetaFile *emf = (wxEnhMetaFile *)data;
default:
{
wxLogError(_("Unsupported clipboard format."));
- return FALSE;
+ return false;
}
case wxDF_OEMTEXT:
handle = SetClipboardData(dataFormat, hGlobalMemory);
break;
}
- // Only tested with non-Unicode, Visual C++ 6.0 so far
-#if defined(__VISUALC__) && !defined(UNICODE)
+ // Only tested with Visual C++ 6.0 so far
+#if defined(__VISUALC__)
case wxDF_HTML:
{
char* html = (char *)data;
-
+
// Create temporary buffer for HTML header...
char *buf = new char [400 + strlen(html)];
- if(!buf) return FALSE;
-
+ 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"
"EndFragment:00000000\r\n"
"<html><body>\r\n"
"<!--StartFragment -->\r\n");
-
+
// Append the HTML...
strcat(buf, html);
strcat(buf, "\r\n");
"<!--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);
+ sprintf(ptr+10, "%08u", strstr(buf, "<html>") - buf);
*(ptr+10+8) = '\r';
-
+
ptr = strstr(buf, "EndHTML");
- wsprintf(ptr+8, "%08u", strlen(buf));
+ sprintf(ptr+8, "%08u", strlen(buf));
*(ptr+8+8) = '\r';
-
+
ptr = strstr(buf, "StartFragment");
- wsprintf(ptr+14, "%08u", strstr(buf, "<!--StartFrag") - buf);
+ sprintf(ptr+14, "%08u", strstr(buf, "<!--StartFrag") - buf);
*(ptr+14+8) = '\r';
-
+
ptr = strstr(buf, "EndFragment");
- wsprintf(ptr+12, "%08u", strstr(buf, "<!--EndFrag") - buf);
+ sprintf(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;
{
wxLogSysError(_("Failed to set clipboard data."));
- return FALSE;
+ return false;
}
- return TRUE;
+ return true;
}
void *wxGetClipboardData(wxDataFormat dataFormat, long *len)
wxClipboard::wxClipboard()
{
- m_clearOnExit = FALSE;
- m_isOpened = FALSE;
+#if wxUSE_OLE_CLIPBOARD
+ wxOleInitialize();
+#endif
+
+ m_lastDataObject = NULL;
+ m_isOpened = false;
}
wxClipboard::~wxClipboard()
{
- if ( m_clearOnExit )
+ if ( m_lastDataObject )
{
Clear();
}
+
+#if wxUSE_OLE_CLIPBOARD
+ wxOleUninitialize();
+#endif
}
void wxClipboard::Clear()
{
#if wxUSE_OLE_CLIPBOARD
- if ( FAILED(OleSetClipboard(NULL)) )
+ if (m_lastDataObject)
+ {
+ // don't touch data set by other applications
+ HRESULT hr = OleIsCurrentClipboard(m_lastDataObject);
+ if (S_OK == hr)
+ {
+ hr = OleSetClipboard(NULL);
+ if ( FAILED(hr) )
{
- wxLogLastError(wxT("OleSetClipboard(NULL)"));
+ wxLogApiError(wxT("OleSetClipboard(NULL)"), hr);
}
-#endif
+ }
+ m_lastDataObject = NULL;
+ }
+#endif // wxUSE_OLE_CLIPBOARD
}
bool wxClipboard::Flush()
{
#if wxUSE_OLE_CLIPBOARD
- if ( FAILED(OleFlushClipboard()) )
+ if (m_lastDataObject)
{
- wxLogLastError(wxT("OleFlushClipboard"));
-
- return FALSE;
- }
- else
+ // don't touch data set by other applications
+ HRESULT hr = OleIsCurrentClipboard(m_lastDataObject);
+ m_lastDataObject = NULL;
+ if (S_OK == hr)
+ {
+ hr = OleFlushClipboard();
+ if ( FAILED(hr) )
{
- m_clearOnExit = FALSE;
+ wxLogApiError(wxT("OleFlushClipboard"), hr);
- return TRUE;
+ return false;
}
+ return true;
+ }
+ }
+ return false;
#else // !wxUSE_OLE_CLIPBOARD
- return FALSE;
+ return false;
#endif // wxUSE_OLE_CLIPBOARD/!wxUSE_OLE_CLIPBOARD
}
bool wxClipboard::Open()
{
// OLE opens clipboard for us
- m_isOpened = TRUE;
+ m_isOpened = true;
#if wxUSE_OLE_CLIPBOARD
- return TRUE;
+ return true;
#else
return wxOpenClipboard();
#endif
if ( data )
return AddData(data);
else
- return TRUE;
+ return true;
}
bool wxClipboard::AddData( wxDataObject *data )
{
- wxCHECK_MSG( data, FALSE, wxT("data is invalid") );
+ wxCHECK_MSG( data, false, wxT("data is invalid") );
#if wxUSE_OLE_CLIPBOARD
HRESULT hr = OleSetClipboard(data->GetInterface());
// don't free anything in this case
- return FALSE;
+ return false;
}
+ // 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 change this
+ m_lastDataObject = data->GetInterface();
+
// 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
// 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;
+ return true;
#elif wxUSE_DATAOBJ
- wxCHECK_MSG( wxIsClipboardOpened(), FALSE, wxT("clipboard not open") );
+ wxCHECK_MSG( wxIsClipboardOpened(), false, wxT("clipboard not open") );
wxDataFormat format = data->GetPreferredFormat();
{
#if 1
// TODO
- wxLogError("Not implemented because wxMetafileDataObject does not contain width and height values.");
- return FALSE;
+ wxLogError(wxT("Not implemented because wxMetafileDataObject does not contain width and height values."));
+ return false;
#else
wxMetafileDataObject* metaFileDataObject =
(wxMetafileDataObject*) data;
// return wxSetClipboardData(data);
// TODO
wxLogError(wxT("Not implemented."));
- return FALSE;
+ return false;
}
}
#else // !wxUSE_DATAOBJ
- return FALSE;
+ return false;
#endif // wxUSE_DATAOBJ/!wxUSE_DATAOBJ
}
void wxClipboard::Close()
{
- m_isOpened = FALSE;
+ m_isOpened = false;
// OLE closes clipboard for us
#if !wxUSE_OLE_CLIPBOARD
wxCloseClipboard();
#endif
}
-bool wxClipboard::IsSupported( wxDataFormat format )
+bool wxClipboard::IsSupported( const wxDataFormat& format )
{
return wxIsClipboardFormatAvailable(format);
}
{
wxLogSysError(hr, _("Failed to get data from the clipboard"));
- return FALSE;
+ return false;
}
// build the list of supported formats
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
- bool result = FALSE;
- wxArrayInt supportedFormats;
IEnumFORMATETC *pEnumFormatEtc = NULL;
hr = pDataObject->EnumFormatEtc(DATADIR_GET, &pEnumFormatEtc);
if ( FAILED(hr) || !pEnumFormatEtc )
else
{
// ask for the supported formats and see if there are any we support
- FORMATETC formatEtc;
for ( ;; )
{
ULONG nCount;
break;
}
- CLIPFORMAT cf = formatEtc.cfFormat;
+ cf = formatEtc.cfFormat;
-#ifdef __WXDEBUG__
wxLogTrace(wxTRACE_OleCalls,
wxT("Object on the clipboard supports format %s."),
wxDataObject::GetFormatName(cf));
-#endif // Debug
-
- // is supported?
- for ( size_t n = 0; n < nFormats; n++ )
- {
- if ( formats[n].GetFormatId() == cf )
- {
- if ( supportedFormats.Index(cf) == wxNOT_FOUND )
- {
- supportedFormats.Add(cf);
- }
- }
- }
}
pEnumFormatEtc->Release();
}
+#endif // Debug
- if ( formats != &format )
+ STGMEDIUM medium;
+ // stop at the first valid format found on the clipboard
+ for ( size_t n = 0; !result && (n < nFormats); n++ )
{
- delete [] formats;
- }
- //else: we didn't allocate any memory
+ // convert to NativeFormat Id
+ cf = formats[n].GetFormatId();
- if ( !supportedFormats.IsEmpty() )
- {
- FORMATETC formatEtc;
+ // 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;
- size_t nSupportedFormats = supportedFormats.GetCount();
- for ( size_t n = 0; !result && (n < nSupportedFormats); n++ )
+ // use the appropriate tymed
+ switch ( formatEtc.cfFormat )
{
- STGMEDIUM medium;
- formatEtc.cfFormat = supportedFormats[n];
+ case CF_BITMAP:
+ formatEtc.tymed = TYMED_GDI;
+ break;
- // use the appropriate tymed
- switch ( formatEtc.cfFormat )
- {
- case CF_BITMAP:
- formatEtc.tymed = TYMED_GDI;
- break;
#ifndef __WXWINCE__
- case CF_METAFILEPICT:
- formatEtc.tymed = TYMED_MFPICT;
- break;
+ case CF_METAFILEPICT:
+ formatEtc.tymed = TYMED_MFPICT;
+ break;
- case CF_ENHMETAFILE:
- formatEtc.tymed = TYMED_ENHMF;
- 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) )
+ 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 )
{
- // try other tymed for GDI objects
- if ( formatEtc.cfFormat == CF_BITMAP )
- {
- formatEtc.tymed = TYMED_HGLOBAL;
- hr = pDataObject->GetData(&formatEtc, &medium);
- }
+ formatEtc.tymed = TYMED_HGLOBAL;
+ hr = pDataObject->GetData(&formatEtc, &medium);
}
+ }
- if ( SUCCEEDED(hr) )
+ if ( SUCCEEDED(hr) )
+ {
+ // pass the data to the data object
+ hr = data.GetInterface()->SetData(&formatEtc, &medium, true);
+ if ( FAILED(hr) )
{
- // pass the data to the data object
- hr = data.GetInterface()->SetData(&formatEtc, &medium, TRUE);
- if ( FAILED(hr) )
- {
- wxLogDebug(wxT("Failed to set data in wxIDataObject"));
+ 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
- {
- result = TRUE;
- }
+ // IDataObject only takes the ownership of data if it
+ // successfully got it - which is not the case here
+ ReleaseStgMedium(&medium);
+ }
+ else
+ {
+ result = true;
}
- //else: unsupported tymed?
}
+ //else: unsupported tymed?
}
- //else: unsupported format
+
+ if ( formats != &format )
+ {
+ delete [] formats;
+ }
+ //else: we didn't allocate any memory
// clean up and return
pDataObject->Release();
return result;
#elif wxUSE_DATAOBJ
- wxCHECK_MSG( wxIsClipboardOpened(), FALSE, wxT("clipboard not open") );
+ wxCHECK_MSG( wxIsClipboardOpened(), false, wxT("clipboard not open") );
wxDataFormat format = data.GetPreferredFormat();
switch ( format )
wxTextDataObject& textDataObject = (wxTextDataObject &)data;
char* s = (char*)wxGetClipboardData(format);
if ( !s )
- return FALSE;
+ return false;
textDataObject.SetText(wxString::FromAscii(s));
delete [] s;
- return TRUE;
+ return true;
}
case wxDF_BITMAP:
wxBitmapDataObject& bitmapDataObject = (wxBitmapDataObject &)data;
wxBitmap* bitmap = (wxBitmap *)wxGetClipboardData(data.GetPreferredFormat());
if ( !bitmap )
- return FALSE;
+ return false;
bitmapDataObject.SetBitmap(*bitmap);
delete bitmap;
- return TRUE;
+ return true;
}
#if wxUSE_METAFILE
case wxDF_METAFILE:
wxMetafileDataObject& metaFileDataObject = (wxMetafileDataObject &)data;
wxMetafile* metaFile = (wxMetafile *)wxGetClipboardData(wxDF_METAFILE);
if ( !metaFile )
- return FALSE;
+ return false;
metaFileDataObject.SetMetafile(*metaFile);
delete metaFile;
- return TRUE;
+ return true;
}
#endif // wxUSE_METAFILE
}
- return FALSE;
+ return false;
#else // !wxUSE_DATAOBJ
wxFAIL_MSG( wxT("no clipboard implementation") );
- return FALSE;
+ return false;
#endif // wxUSE_OLE_CLIPBOARD/wxUSE_DATAOBJ
}
#endif // wxUSE_CLIPBOARD
-