CEGUI::Clipboard Class Reference

Defines a clipboard handling class. More...

#include <Clipboard.h>

Inheritance diagram for CEGUI::Clipboard:

Collaboration diagram for CEGUI::Clipboard:

Public Member Functions
	Clipboard ()
	constructor
	~Clipboard ()
	destructor
void	setNativeProvider (NativeClipboardProvider *provider)
	sets native clipboard provider
NativeClipboardProvider *	getNativeProvider () const
	retrieves currently set native clipboard provider
void	setData (const String &mimeType, const void *buffer, size_t size)
	sets contents of this clipboard to given raw data
void	getData (String &mimeType, const void *&buffer, size_t &size)
	retrieves contents of this clipboard as raw data
void	setText (const String &text)
	convenience method that sets contents to given string
String	getText ()
	convenience method that retrieves contents as a string

Detailed Description

Defines a clipboard handling class.

Usually, there is just one instance of this class, owned by CEGUI::System, it contains internal CEGUI clipboard that may be (optionally) synchronised with native clipboard if user sets NativeClipboardProvider with:

CEGUI::System::getSingleton()->getClipboard()->setNativeProvider(customProvider)

Where customProvider is of course user implemented clipboard provider.

Member Function Documentation

getData()

void CEGUI::Clipboard::getData	(	String &	mimeType,
		const void *&	buffer,
		size_t &	size
	)

retrieves contents of this clipboard as raw data

Parameters

mimeType	current mime type
buffer	the raw data buffer (can be 0 if size == 0!)
size	size of the returned buffer

You shan't change the buffer contents, only read from it!

getNativeProvider()

NativeClipboardProvider * CEGUI::Clipboard::getNativeProvider

(

)

const

retrieves currently set native clipboard provider

See also

NativeClipboardProvider

setData()

void CEGUI::Clipboard::setData	(	const String &	mimeType,
		const void *	buffer,
		size_t	size
	)

sets contents of this clipboard to given raw data

Parameters

mimeType	describes type of the data in the clipboard
buffer	raw buffer containing data to push into the clipboard
size	size (in bytes) of given data

setNativeProvider()

void CEGUI::Clipboard::setNativeProvider

(

NativeClipboardProvider *

provider

)

sets native clipboard provider

Parameters

provider

the native clipboard provider to set

See also

NativeClipboardProvider You are required to deallocate given provider, this class doesn't take ownership!)