b5dbe15d0b
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@47254 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
97 lines
3.2 KiB
C++
97 lines
3.2 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: clipbrd.h
|
|
// Purpose: Clipboard functionality.
|
|
// Note: this functionality is under review, and
|
|
// is derived from wxWidgets 1.xx code. Please contact
|
|
// the wxWidgets developers for further information.
|
|
// Author: David Webster
|
|
// Modified by:
|
|
// Created: 10/13/99
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) David Webster
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_CLIPBRD_H_
|
|
#define _WX_CLIPBRD_H_
|
|
|
|
#if wxUSE_CLIPBOARD
|
|
|
|
#include "wx/list.h"
|
|
#include "wx/module.h"
|
|
#include "wx/dataobj.h" // for wxDataFormat
|
|
|
|
// These functions superceded by wxClipboard, but retained in order to
|
|
// implement wxClipboard, and for compatibility.
|
|
|
|
// open/close the clipboard
|
|
WXDLLEXPORT bool wxOpenClipboard();
|
|
WXDLLEXPORT bool wxIsClipboardOpened();
|
|
#define wxClipboardOpen wxIsClipboardOpened
|
|
WXDLLEXPORT bool wxCloseClipboard();
|
|
|
|
// get/set data
|
|
WXDLLEXPORT bool wxEmptyClipboard();
|
|
WXDLLEXPORT bool wxSetClipboardData(wxDataFormat dataFormat,
|
|
const void *data,
|
|
int width = 0, int height = 0);
|
|
WXDLLEXPORT void* wxGetClipboardData(wxDataFormat dataFormat,
|
|
long *len = NULL);
|
|
|
|
// clipboard formats
|
|
WXDLLEXPORT bool wxIsClipboardFormatAvailable(wxDataFormat dataFormat);
|
|
WXDLLEXPORT wxDataFormat wxEnumClipboardFormats(wxDataFormat dataFormat);
|
|
WXDLLEXPORT int wxRegisterClipboardFormat(wxChar *formatName);
|
|
WXDLLEXPORT bool wxGetClipboardFormatName(wxDataFormat dataFormat,
|
|
wxChar *formatName,
|
|
int maxCount);
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// wxClipboard
|
|
//-----------------------------------------------------------------------------
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxDataObject;
|
|
class WXDLLEXPORT wxClipboard : public wxClipboardBase
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxClipboard)
|
|
|
|
public:
|
|
wxClipboard();
|
|
virtual ~wxClipboard();
|
|
|
|
// open the clipboard before SetData() and GetData()
|
|
virtual bool Open();
|
|
|
|
// close the clipboard after SetData() and GetData()
|
|
virtual void Close();
|
|
|
|
// query whether the clipboard is opened
|
|
virtual bool IsOpened() const;
|
|
|
|
// set the clipboard data. all other formats will be deleted.
|
|
virtual bool SetData( wxDataObject *data );
|
|
|
|
// add to the clipboard data.
|
|
virtual bool AddData( wxDataObject *data );
|
|
|
|
// ask if data in correct format is available
|
|
virtual bool IsSupported( const wxDataFormat& format );
|
|
|
|
// fill data with data on the clipboard (if available)
|
|
virtual bool GetData( wxDataObject& data );
|
|
|
|
// clears wxTheClipboard and the system's clipboard if possible
|
|
virtual void Clear();
|
|
|
|
// flushes the clipboard: this means that the data which is currently on
|
|
// clipboard will stay available even after the application exits (possibly
|
|
// eating memory), otherwise the clipboard will be emptied on exit
|
|
virtual bool Flush();
|
|
|
|
private:
|
|
bool m_clearOnExit;
|
|
};
|
|
|
|
#endif // wxUSE_CLIPBOARD
|
|
#endif // _WX_CLIPBRD_H_
|