/////////////////////////////////////////////////////////////////////////////
-// Name: clipbrd.cpp
+// Name: src/msw/clipbrd.cpp
// Purpose: Clipboard functionality
// Author: Julian Smart
// 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
/////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation "clipbrd.h"
-#endif
+// ===========================================================================
+// declarations
+// ===========================================================================
+
+// ---------------------------------------------------------------------------
+// headers
+// ---------------------------------------------------------------------------
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
-#pragma hdrstop
-#endif
-
-#ifndef WX_PRECOMP
-#include "wx/setup.h"
+ #pragma hdrstop
#endif
#if wxUSE_CLIPBOARD
+#include "wx/clipbrd.h"
+
#ifndef WX_PRECOMP
-#include "wx/object.h"
-#include "wx/event.h"
-#include "wx/app.h"
-#include "wx/frame.h"
-#include "wx/bitmap.h"
-#include "wx/utils.h"
+ #include "wx/object.h"
+ #include "wx/event.h"
+ #include "wx/app.h"
+ #include "wx/frame.h"
+ #include "wx/bitmap.h"
+ #include "wx/utils.h"
+ #include "wx/intl.h"
+ #include "wx/log.h"
+#endif
+
+#if wxUSE_METAFILE
+ #include "wx/metafile.h"
#endif
-#include "wx/metafile.h"
-#include "wx/clipbrd.h"
-#include "wx/msw/private.h"
-#include "wx/msw/dib.h"
#include <string.h>
-#if !USE_SHARED_LIBRARY
-IMPLEMENT_DYNAMIC_CLASS(wxClipboard, wxObject)
-IMPLEMENT_ABSTRACT_CLASS(wxClipboardClient, wxObject)
+#include "wx/msw/private.h"
+#include "wx/msw/ole/oleutils.h"
+
+#if wxUSE_WXDIB
+ #include "wx/msw/dib.h"
#endif
-bool wxClipboardIsOpen = FALSE;
+// 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
-bool wxOpenClipboard(void)
-{
- if (wxTheApp->GetTopWindow() && !wxClipboardIsOpen)
- {
- wxClipboardIsOpen = (::OpenClipboard((HWND) wxTheApp->GetTopWindow()->GetHWND()) != 0);
- return wxClipboardIsOpen;
- }
- else return FALSE;
-}
+#if wxUSE_DATAOBJ
+ #include "wx/dataobj.h"
+#endif
+
+#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
-bool wxCloseClipboard(void)
+// ===========================================================================
+// implementation
+// ===========================================================================
+
+// ---------------------------------------------------------------------------
+// old-style clipboard functions using Windows API
+// ---------------------------------------------------------------------------
+
+static bool gs_wxClipboardIsOpen = false;
+
+bool wxOpenClipboard()
{
- if (wxClipboardIsOpen)
- {
- wxClipboardIsOpen = FALSE;
- }
- return (::CloseClipboard() != 0);
+ wxCHECK_MSG( !gs_wxClipboardIsOpen, true, wxT("clipboard already opened.") );
+
+ wxWindow *win = wxTheApp->GetTopWindow();
+ if ( win )
+ {
+ gs_wxClipboardIsOpen = ::OpenClipboard((HWND)win->GetHWND()) != 0;
+
+ if ( !gs_wxClipboardIsOpen )
+ wxLogSysError(_("Failed to open the clipboard."));
+
+ return gs_wxClipboardIsOpen;
+ }
+ else
+ {
+ wxLogDebug(wxT("Can not open clipboard without a main window."));
+
+ return false;
+ }
}
-bool wxEmptyClipboard(void)
+bool wxCloseClipboard()
{
- return (::EmptyClipboard() != 0);
+ wxCHECK_MSG( gs_wxClipboardIsOpen, false, wxT("clipboard is not opened") );
+
+ gs_wxClipboardIsOpen = false;
+
+ if ( ::CloseClipboard() == 0 )
+ {
+ wxLogSysError(_("Failed to close the clipboard."));
+
+ return false;
+ }
+
+ return true;
}
-bool wxClipboardOpen(void)
+bool wxEmptyClipboard()
{
- return wxClipboardIsOpen;
+ if ( ::EmptyClipboard() == 0 )
+ {
+ wxLogSysError(_("Failed to empty the clipboard."));
+
+ return false;
+ }
+
+ return true;
}
-bool wxIsClipboardFormatAvailable(int dataFormat)
+bool wxIsClipboardOpened()
{
- return (::IsClipboardFormatAvailable(dataFormat) != 0);
+ return gs_wxClipboardIsOpen;
}
-bool wxSetClipboardData(int dataFormat, wxObject *obj, int width, int height)
+bool wxIsClipboardFormatAvailable(wxDataFormat dataFormat)
{
- switch (dataFormat)
- {
- case wxDF_BITMAP:
+ wxDataFormat::NativeFormat cf = dataFormat.GetFormatId();
+
+ if ( ::IsClipboardFormatAvailable(cf) )
{
- wxBitmap *wxBM = (wxBitmap *)obj;
-
- HDC hdcMem = CreateCompatibleDC(NULL);
- HDC hdcSrc = CreateCompatibleDC(NULL);
- HBITMAP old = (HBITMAP) ::SelectObject(hdcSrc, (HBITMAP) wxBM->GetHBITMAP());
- HBITMAP hBitmap = CreateCompatibleBitmap(hdcSrc,
- wxBM->GetWidth(), wxBM->GetHeight());
- if (!hBitmap)
- {
- SelectObject(hdcSrc, old);
- DeleteDC(hdcMem);
- DeleteDC(hdcSrc);
- return FALSE;
- }
- HBITMAP old1 = (HBITMAP) SelectObject(hdcMem, hBitmap);
- BitBlt(hdcMem, 0, 0, wxBM->GetWidth(), wxBM->GetHeight(),
- hdcSrc, 0, 0, SRCCOPY);
-
- // Select new bitmap out of memory DC
- SelectObject(hdcMem, old1);
-
- // Set the data
- bool success = (bool)(::SetClipboardData(CF_BITMAP, hBitmap) != 0);
-
- // Clean up
- SelectObject(hdcSrc, old);
- DeleteDC(hdcSrc);
- DeleteDC(hdcMem);
- return success;
- break;
+ // ok from the first try
+ return true;
}
- case wxDF_DIB:
- {
-#if wxUSE_IMAGE_LOADING_IN_MSW
- HBITMAP hBitmap=(HBITMAP) ((wxBitmap *)obj)->GetHBITMAP();
- HANDLE hDIB=BitmapToDIB(hBitmap,NULL); // NULL==uses system palette
- bool success = (::SetClipboardData(CF_DIB,hDIB) != 0);
-#else
- bool success=FALSE;
-#endif
- return success;
- break;
- }
-#if wxUSE_METAFILE
- case wxDF_METAFILE:
+
+ // for several standard formats, we can convert from some other ones too
+ switch ( cf )
{
- wxMetaFile *wxMF = (wxMetaFile *)obj;
- HANDLE data = GlobalAlloc(GHND, sizeof(METAFILEPICT) + 1);
-#ifdef __WINDOWS_386__
- METAFILEPICT *mf = (METAFILEPICT *)MK_FP32(GlobalLock(data));
-#else
- METAFILEPICT *mf = (METAFILEPICT *)GlobalLock(data);
-#endif
+ // for bitmaps, DIBs will also do
+ case CF_BITMAP:
+ return ::IsClipboardFormatAvailable(CF_DIB) != 0;
- mf->mm = wxMF->GetWindowsMappingMode();
- mf->xExt = width;
- mf->yExt = height;
- mf->hMF = (HMETAFILE) wxMF->GetHMETAFILE();
- GlobalUnlock(data);
- wxMF->SetHMETAFILE((WXHANDLE) NULL);
+#if wxUSE_ENH_METAFILE && !defined(__WXWINCE__)
+ case CF_METAFILEPICT:
+ return ::IsClipboardFormatAvailable(CF_ENHMETAFILE) != 0;
+#endif // wxUSE_ENH_METAFILE
- return (SetClipboardData(CF_METAFILEPICT, data) != 0);
- break;
+ default:
+ return false;
}
-#endif
- case CF_SYLK:
- case CF_DIF:
- case CF_TIFF:
- case CF_PALETTE:
- {
- return FALSE;
- break;
- }
- case wxDF_OEMTEXT:
- dataFormat = wxDF_TEXT;
- case wxDF_TEXT:
- width = strlen((char *)obj) + 1;
- height = 1;
- default:
- {
- char *s = (char *)obj;
- DWORD l;
+}
- l = (width * height);
- HANDLE hGlobalMemory = GlobalAlloc(GHND, l);
- if (!hGlobalMemory)
- return FALSE;
-#ifdef __WINDOWS_386__
- LPSTR lpGlobalMemory = (LPSTR)MK_FP32(GlobalLock(hGlobalMemory));
-#else
- LPSTR lpGlobalMemory = (LPSTR)GlobalLock(hGlobalMemory);
+bool wxSetClipboardData(wxDataFormat dataFormat,
+ const void *data,
+ int width, int height)
+{
+ HANDLE handle = 0; // return value of SetClipboardData
+
+ switch (dataFormat)
+ {
+ case wxDF_BITMAP:
+ {
+ wxBitmap *bitmap = (wxBitmap *)data;
+
+ HDC hdcMem = CreateCompatibleDC((HDC) NULL);
+ HDC hdcSrc = CreateCompatibleDC((HDC) NULL);
+ HBITMAP old = (HBITMAP)
+ ::SelectObject(hdcSrc, (HBITMAP)bitmap->GetHBITMAP());
+ HBITMAP hBitmap = CreateCompatibleBitmap(hdcSrc,
+ bitmap->GetWidth(),
+ bitmap->GetHeight());
+ if (!hBitmap)
+ {
+ SelectObject(hdcSrc, old);
+ DeleteDC(hdcMem);
+ DeleteDC(hdcSrc);
+ return false;
+ }
+
+ HBITMAP old1 = (HBITMAP) SelectObject(hdcMem, hBitmap);
+ BitBlt(hdcMem, 0, 0, bitmap->GetWidth(), bitmap->GetHeight(),
+ hdcSrc, 0, 0, SRCCOPY);
+
+ // Select new bitmap out of memory DC
+ SelectObject(hdcMem, old1);
+
+ // Set the data
+ handle = ::SetClipboardData(CF_BITMAP, hBitmap);
+
+ // Clean up
+ SelectObject(hdcSrc, old);
+ DeleteDC(hdcSrc);
+ DeleteDC(hdcMem);
+ break;
+ }
+
+#if wxUSE_WXDIB
+ case wxDF_DIB:
+ {
+ wxBitmap *bitmap = (wxBitmap *)data;
+
+ if ( bitmap && bitmap->Ok() )
+ {
+ wxDIB dib(*bitmap);
+ if ( dib.IsOk() )
+ {
+ handle = ::SetClipboardData(CF_DIB, dib.Detach());
+ }
+ }
+ break;
+ }
#endif
-#ifdef __WIN32__
- memcpy(lpGlobalMemory, s, l);
-#elif defined(__WATCOMC__) && defined(__WINDOWS_386__)
- memcpy(lpGlobalMemory, s, l);
-#else
- hmemcpy(lpGlobalMemory, s, l);
+ // 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 data = GlobalAlloc(GHND, sizeof(METAFILEPICT) + 1);
+ METAFILEPICT *mf = (METAFILEPICT *)GlobalLock(data);
+
+ mf->mm = wxMF->GetWindowsMappingMode();
+ mf->xExt = width;
+ mf->yExt = height;
+ mf->hMF = (HMETAFILE) wxMF->GetHMETAFILE();
+ GlobalUnlock(data);
+ wxMF->SetHMETAFILE((WXHANDLE) NULL);
+
+ handle = SetClipboardData(CF_METAFILEPICT, data);
+ break;
+ }
+#endif // wxUSE_METAFILE
+
+#if wxUSE_ENH_METAFILE && !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:
+ case CF_PALETTE:
+ default:
+ {
+ wxLogError(_("Unsupported clipboard format."));
+ return false;
+ }
+
+ case wxDF_OEMTEXT:
+ dataFormat = wxDF_TEXT;
+ // fall through
+
+ case wxDF_TEXT:
+ {
+ char *s = (char *)data;
+
+ width = strlen(s) + 1;
+ height = 1;
+ DWORD l = (width * height);
+ HANDLE hGlobalMemory = GlobalAlloc(GHND, l);
+ if ( hGlobalMemory )
+ {
+ LPSTR lpGlobalMemory = (LPSTR)GlobalLock(hGlobalMemory);
+
+ memcpy(lpGlobalMemory, s, l);
+
+ GlobalUnlock(hGlobalMemory);
+ }
+
+ handle = SetClipboardData(dataFormat, hGlobalMemory);
+ break;
+ }
+ // 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;
+
+ // 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");
+ sprintf(ptr+10, "%08u", strstr(buf, "<html>") - buf);
+ *(ptr+10+8) = '\r';
+
+ ptr = strstr(buf, "EndHTML");
+ sprintf(ptr+8, "%08u", strlen(buf));
+ *(ptr+8+8) = '\r';
+
+ ptr = strstr(buf, "StartFragment");
+ sprintf(ptr+14, "%08u", strstr(buf, "<!--StartFrag") - buf);
+ *(ptr+14+8) = '\r';
+
+ ptr = strstr(buf, "EndFragment");
+ 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;
+ }
#endif
+ }
- GlobalUnlock(hGlobalMemory);
- HANDLE success = SetClipboardData(dataFormat, hGlobalMemory);
- return (success != 0);
- break;
+ if ( handle == 0 )
+ {
+ wxLogSysError(_("Failed to set clipboard data."));
+
+ return false;
}
- }
- return FALSE;
+
+ return true;
}
-wxObject *wxGetClipboardData(int dataFormat, long *len)
+void *wxGetClipboardData(wxDataFormat dataFormat, long *len)
{
- switch (dataFormat)
- {
- case wxDF_BITMAP:
- {
- BITMAP bm;
- HBITMAP hBitmap = (HBITMAP) GetClipboardData(CF_BITMAP);
- if (!hBitmap)
- return NULL;
-
- HDC hdcMem = CreateCompatibleDC(NULL);
- HDC hdcSrc = CreateCompatibleDC(NULL);
-
- HBITMAP old = (HBITMAP) ::SelectObject(hdcSrc, hBitmap);
- GetObject(hBitmap, sizeof(BITMAP), (LPSTR)&bm);
-
- HBITMAP hNewBitmap = CreateBitmapIndirect(&bm);
-
- if (!hNewBitmap)
- {
- SelectObject(hdcSrc, old);
- DeleteDC(hdcMem);
- DeleteDC(hdcSrc);
- return NULL;
- }
-
- HBITMAP old1 = (HBITMAP) SelectObject(hdcMem, hNewBitmap);
- BitBlt(hdcMem, 0, 0, bm.bmWidth, bm.bmHeight,
- hdcSrc, 0, 0, SRCCOPY);
-
- // Select new bitmap out of memory DC
- SelectObject(hdcMem, old1);
-
- // Clean up
- SelectObject(hdcSrc, old);
- DeleteDC(hdcSrc);
- DeleteDC(hdcMem);
-
- // Create and return a new wxBitmap
- wxBitmap *wxBM = new wxBitmap;
- wxBM->SetHBITMAP((WXHBITMAP) hNewBitmap);
- wxBM->SetWidth(bm.bmWidth);
- wxBM->SetHeight(bm.bmHeight);
- wxBM->SetDepth(bm.bmPlanes);
- wxBM->SetOk(TRUE);
- return (wxObject *)wxBM;
- break;
- }
- case wxDF_METAFILE:
- case CF_SYLK:
- case CF_DIF:
- case CF_TIFF:
- case CF_PALETTE:
- case wxDF_DIB:
- {
- return FALSE;
- break;
- }
- case wxDF_OEMTEXT:
- dataFormat = wxDF_TEXT;
- case wxDF_TEXT:
- default:
+ void *retval = NULL;
+
+ switch ( dataFormat )
{
- HANDLE hGlobalMemory = GetClipboardData(dataFormat);
- if (!hGlobalMemory)
- return NULL;
+#ifndef __WXWINCE__
+ case wxDF_BITMAP:
+ {
+ BITMAP bm;
+ HBITMAP hBitmap = (HBITMAP) GetClipboardData(CF_BITMAP);
+ if (!hBitmap)
+ break;
+
+ HDC hdcMem = CreateCompatibleDC((HDC) NULL);
+ HDC hdcSrc = CreateCompatibleDC((HDC) NULL);
+
+ HBITMAP old = (HBITMAP) ::SelectObject(hdcSrc, hBitmap);
+ GetObject(hBitmap, sizeof(BITMAP), (LPSTR)&bm);
+
+ HBITMAP hNewBitmap = CreateBitmapIndirect(&bm);
+
+ if (!hNewBitmap)
+ {
+ SelectObject(hdcSrc, old);
+ DeleteDC(hdcMem);
+ DeleteDC(hdcSrc);
+ break;
+ }
+
+ HBITMAP old1 = (HBITMAP) SelectObject(hdcMem, hNewBitmap);
+ BitBlt(hdcMem, 0, 0, bm.bmWidth, bm.bmHeight,
+ hdcSrc, 0, 0, SRCCOPY);
+
+ // Select new bitmap out of memory DC
+ SelectObject(hdcMem, old1);
+
+ // Clean up
+ SelectObject(hdcSrc, old);
+ DeleteDC(hdcSrc);
+ DeleteDC(hdcMem);
+
+ // Create and return a new wxBitmap
+ wxBitmap *wxBM = new wxBitmap;
+ wxBM->SetHBITMAP((WXHBITMAP) hNewBitmap);
+ wxBM->SetWidth(bm.bmWidth);
+ wxBM->SetHeight(bm.bmHeight);
+ wxBM->SetDepth(bm.bmPlanes);
+ 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 NULL;
+
+ case wxDF_OEMTEXT:
+ dataFormat = wxDF_TEXT;
+ // fall through
+
+ case wxDF_TEXT:
+ {
+ HANDLE hGlobalMemory = ::GetClipboardData(dataFormat);
+ if (!hGlobalMemory)
+ break;
- int hsize = (int)GlobalSize(hGlobalMemory);
- if (len)
- *len = hsize;
+ DWORD hsize = ::GlobalSize(hGlobalMemory);
+ if (len)
+ *len = hsize;
- char *s = new char[hsize];
- if (!s)
- return NULL;
+ char *s = new char[hsize];
+ if (!s)
+ break;
-#ifdef __WINDOWS_386__
- LPSTR lpGlobalMemory = (LPSTR)MK_FP32(GlobalLock(hGlobalMemory));
-#else
- LPSTR lpGlobalMemory = (LPSTR)GlobalLock(hGlobalMemory);
-#endif
+ LPSTR lpGlobalMemory = (LPSTR) GlobalLock(hGlobalMemory);
-#ifdef __WIN32__
- memcpy(s, lpGlobalMemory, GlobalSize(hGlobalMemory));
-#elif __WATCOMC__ && defined(__WINDOWS_386__)
- memcpy(s, lpGlobalMemory, GlobalSize(hGlobalMemory));
-#else
- hmemcpy(s, lpGlobalMemory, GlobalSize(hGlobalMemory));
-#endif
+ memcpy(s, lpGlobalMemory, hsize);
+
+ GlobalUnlock(hGlobalMemory);
+
+ retval = s;
+ break;
+ }
+
+ default:
+ {
+ HANDLE hGlobalMemory = ::GetClipboardData(dataFormat);
+ if ( !hGlobalMemory )
+ break;
+
+ DWORD size = ::GlobalSize(hGlobalMemory);
+ if ( len )
+ *len = size;
- GlobalUnlock(hGlobalMemory);
+ void *buf = malloc(size);
+ if ( !buf )
+ break;
- return (wxObject *)s;
- break;
+ LPSTR lpGlobalMemory = (LPSTR) GlobalLock(hGlobalMemory);
+
+ memcpy(buf, lpGlobalMemory, size);
+
+ GlobalUnlock(hGlobalMemory);
+
+ retval = buf;
+ break;
+ }
+ }
+
+ if ( !retval )
+ {
+ wxLogSysError(_("Failed to retrieve data from the clipboard."));
}
- }
- return NULL;
+
+ return retval;
}
-int wxEnumClipboardFormats(int dataFormat)
+wxDataFormat wxEnumClipboardFormats(wxDataFormat dataFormat)
{
- return ::EnumClipboardFormats(dataFormat);
+ return (wxDataFormat::NativeFormat)::EnumClipboardFormats(dataFormat);
}
-int wxRegisterClipboardFormat(char *formatName)
+int wxRegisterClipboardFormat(wxChar *formatName)
{
return ::RegisterClipboardFormat(formatName);
}
-bool wxGetClipboardFormatName(int dataFormat, char *formatName, int maxCount)
+bool wxGetClipboardFormatName(wxDataFormat dataFormat,
+ wxChar *formatName,
+ int maxCount)
{
- return (::GetClipboardFormatName(dataFormat, formatName, maxCount) > 0);
+ return ::GetClipboardFormatName((int)dataFormat, formatName, maxCount) > 0;
}
-/*
- * Generalized clipboard implementation by Matthew Flatt
- */
+// ---------------------------------------------------------------------------
+// wxClipboard
+// ---------------------------------------------------------------------------
-wxClipboard *wxTheClipboard = NULL;
+IMPLEMENT_DYNAMIC_CLASS(wxClipboard, wxObject)
-void wxInitClipboard(void)
+wxClipboard::wxClipboard()
{
- if (!wxTheClipboard)
- wxTheClipboard = new wxClipboard;
+#if wxUSE_OLE_CLIPBOARD
+ wxOleInitialize();
+#endif
+
+ m_lastDataObject = NULL;
+ m_isOpened = false;
}
-wxClipboard::wxClipboard()
+wxClipboard::~wxClipboard()
{
- clipOwner = NULL;
- cbString = NULL;
+ if ( m_lastDataObject )
+ {
+ Clear();
+ }
+
+#if wxUSE_OLE_CLIPBOARD
+ wxOleUninitialize();
+#endif
}
-wxClipboard::~wxClipboard()
+void wxClipboard::Clear()
{
- if (clipOwner)
- clipOwner->BeingReplaced();
- if (cbString)
- delete[] cbString;
+#if wxUSE_OLE_CLIPBOARD
+ 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) )
+ {
+ wxLogApiError(wxT("OleSetClipboard(NULL)"), hr);
+ }
+ }
+ m_lastDataObject = NULL;
+ }
+#endif // wxUSE_OLE_CLIPBOARD
}
-static int FormatStringToID(char *str)
+bool wxClipboard::Flush()
{
- if (!strcmp(str, "TEXT"))
- return wxDF_TEXT;
+#if wxUSE_OLE_CLIPBOARD
+ if (m_lastDataObject)
+ {
+ // 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) )
+ {
+ wxLogApiError(wxT("OleFlushClipboard"), hr);
- return wxRegisterClipboardFormat(str);
+ return false;
+ }
+ return true;
+ }
+ }
+ return false;
+#else // !wxUSE_OLE_CLIPBOARD
+ return false;
+#endif // wxUSE_OLE_CLIPBOARD/!wxUSE_OLE_CLIPBOARD
}
-void wxClipboard::SetClipboardClient(wxClipboardClient *client, long time)
+bool wxClipboard::Open()
{
- bool got_selection;
-
- if (clipOwner)
- clipOwner->BeingReplaced();
- clipOwner = client;
- if (cbString) {
- delete[] cbString;
- cbString = NULL;
- }
-
- if (wxOpenClipboard()) {
- char **formats, *data;
- int i;
- int ftype;
- long size;
-
- formats = clipOwner->formats.ListToArray(FALSE);
- for (i = clipOwner->formats.Number(); i--; ) {
- ftype = FormatStringToID(formats[i]);
- data = clipOwner->GetData(formats[i], &size);
- if (!wxSetClipboardData(ftype, (wxObject *)data, size, 1)) {
- got_selection = FALSE;
- break;
- }
- }
+ // OLE opens clipboard for us
+ m_isOpened = true;
+#if wxUSE_OLE_CLIPBOARD
+ return true;
+#else
+ return wxOpenClipboard();
+#endif
+}
- if (i < 0)
- got_selection = wxCloseClipboard();
- } else
- got_selection = FALSE;
-
- got_selection = FALSE; // Assume another process takes over
-
- if (!got_selection) {
- clipOwner->BeingReplaced();
- clipOwner = NULL;
- }
+bool wxClipboard::IsOpened() const
+{
+#if wxUSE_OLE_CLIPBOARD
+ return m_isOpened;
+#else
+ return wxIsClipboardOpened();
+#endif
}
-wxClipboardClient *wxClipboard::GetClipboardClient()
+bool wxClipboard::SetData( wxDataObject *data )
{
- return clipOwner;
+#if !wxUSE_OLE_CLIPBOARD
+ (void)wxEmptyClipboard();
+#endif // wxUSE_OLE_CLIPBOARD
+
+ if ( data )
+ return AddData(data);
+ else
+ return true;
}
-void wxClipboard::SetClipboardString(char *str, long time)
+bool wxClipboard::AddData( wxDataObject *data )
{
- bool got_selection;
+ wxCHECK_MSG( data, false, wxT("data is invalid") );
- if (clipOwner) {
- clipOwner->BeingReplaced();
- clipOwner = NULL;
- }
- if (cbString)
- delete[] cbString;
+#if wxUSE_OLE_CLIPBOARD
+ HRESULT hr = OleSetClipboard(data->GetInterface());
+ if ( FAILED(hr) )
+ {
+ wxLogSysError(hr, _("Failed to put data on the clipboard"));
- cbString = str;
+ // don't free anything in this case
- if (wxOpenClipboard()) {
- if (!wxSetClipboardData(wxDF_TEXT, (wxObject *)str))
- got_selection = FALSE;
- else
- got_selection = wxCloseClipboard();
- } else
- got_selection = 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
+ // 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();
- got_selection = FALSE; // Assume another process takes over
+ return true;
+#elif wxUSE_DATAOBJ
+ wxCHECK_MSG( wxIsClipboardOpened(), false, wxT("clipboard not open") );
- if (!got_selection) {
- delete[] cbString;
- cbString = NULL;
- }
+ wxDataFormat format = data->GetPreferredFormat();
+
+ switch ( format )
+ {
+ case wxDF_TEXT:
+ case wxDF_OEMTEXT:
+ {
+ wxTextDataObject* textDataObject = (wxTextDataObject*) data;
+ wxString str(textDataObject->GetText());
+ return wxSetClipboardData(format, str.c_str());
+ }
+
+ case wxDF_BITMAP:
+ case wxDF_DIB:
+ {
+ wxBitmapDataObject* bitmapDataObject = (wxBitmapDataObject*) data;
+ wxBitmap bitmap(bitmapDataObject->GetBitmap());
+ return wxSetClipboardData(data->GetPreferredFormat(), &bitmap);
+ }
+
+#if wxUSE_METAFILE
+ case wxDF_METAFILE:
+ {
+#if 1
+ // TODO
+ wxLogError(wxT("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:
+ {
+// This didn't compile, of course
+// return wxSetClipboardData(data);
+ // TODO
+ wxLogError(wxT("Not implemented."));
+ return false;
+ }
+ }
+#else // !wxUSE_DATAOBJ
+ return false;
+#endif // wxUSE_DATAOBJ/!wxUSE_DATAOBJ
}
-char *wxClipboard::GetClipboardString(long time)
+void wxClipboard::Close()
{
- char *str;
- long length;
-
- str = GetClipboardData("TEXT", &length, time);
- if (!str) {
- str = new char[1];
- *str = 0;
- }
+ m_isOpened = false;
+ // OLE closes clipboard for us
+#if !wxUSE_OLE_CLIPBOARD
+ wxCloseClipboard();
+#endif
+}
- return str;
+bool wxClipboard::IsSupported( const wxDataFormat& format )
+{
+ return wxIsClipboardFormatAvailable(format);
}
-char *wxClipboard::GetClipboardData(char *format, long *length, long time)
+bool wxClipboard::GetData( wxDataObject& data )
{
- if (clipOwner) {
- if (clipOwner->formats.Member(format))
- return clipOwner->GetData(format, length);
+#if wxUSE_OLE_CLIPBOARD
+ IDataObject *pDataObject = NULL;
+ HRESULT hr = OleGetClipboard(&pDataObject);
+ if ( FAILED(hr) || !pDataObject )
+ {
+ wxLogSysError(hr, _("Failed to get data from the clipboard"));
+
+ return false;
+ }
+
+ // build the list of supported formats
+ size_t nFormats = data.GetFormatCount(wxDataObject::Set);
+ wxDataFormat format;
+ wxDataFormat *formats;
+ if ( nFormats == 1 )
+ {
+ // the most common case
+ formats = &format;
+ }
else
- return NULL;
- } else if (cbString) {
- if (!strcmp(format, "TEXT"))
- return copystring(cbString);
+ {
+ // 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
- return NULL;
- } else {
- if (wxOpenClipboard()) {
- receivedString = (char *)wxGetClipboardData(FormatStringToID(format),
- length);
- wxCloseClipboard();
- } else
- receivedString = NULL;
-
- return receivedString;
- }
-}
+ {
+ // ask for the supported formats and see if there are any we support
+ for ( ;; )
+ {
+ ULONG nCount;
+ hr = pEnumFormatEtc->Next(1, &formatEtc, &nCount);
+
+ // don't use FAILED() because S_FALSE would pass it
+ if ( hr != S_OK )
+ {
+ // no more formats
+ break;
+ }
+
+ cf = formatEtc.cfFormat;
+
+ wxLogTrace(wxTRACE_OleCalls,
+ wxT("Object on the clipboard supports format %s."),
+ wxDataObject::GetFormatName(cf));
+ }
+
+ 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 )
+ {
+ 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
-#endif // wxUSE_CLIPBOARD
+ 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 )
+ {
+ formatEtc.tymed = TYMED_HGLOBAL;
+ hr = pDataObject->GetData(&formatEtc, &medium);
+ }
+ }
+
+ if ( SUCCEEDED(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"));
+
+ // 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?
+ }
+
+ 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") );
+
+ 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;
+
+ textDataObject.SetText(wxString::FromAscii(s));
+ delete [] s;
+
+ 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
+}
+#endif // wxUSE_CLIPBOARD
projects / wxWidgets.git / blobdiff