Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: datatransfer :: clipboard ::

interface XClipboard
Developers Guide
OfficeDev - Common Application Features - Clipboard

Methods' Summary
getContents To get the current content of the clipboard.  
setContents Sets the current contents of the clipboard to the specified transferable object and registers the specified clipboard owner as the owner of the new contents.  
getName To get the name of the clipboard instance.  
Methods' Details
getContents
::com::sun::star::datatransfer::XTransferable
getContents();

Description
To get the current content of the clipboard.
Returns
The transferable object representing the current content of this clipboard.
See also
::com::sun::star::datatransfer::XTransferable
setContents
[oneway] void
setContents( [in] ::com::sun::star::datatransfer::XTransferable  xTrans,
[in] XClipboardOwner  xClipboardOwner );

Description
Sets the current contents of the clipboard to the specified transferable object and registers the specified clipboard owner as the owner of the new contents.
Parameter xTrans
The transferable object to set as new content.

If the given ::com::sun::star::datatransfer::XTransferable has no ::com::sun::star::datatransfer::DataFlavor the clipboard will be deleted.

A NULL value is not allowed.

Parameter xClipboardOwner
The new owner of the clipboard.

NULL is an acceptable value and means that the caller is not interested in lost ownership notifications.

See also
::com::sun::star::datatransfer::XTransferable, XClipboardOwner
getName
string
getName();

Description
To get the name of the clipboard instance.
Returns
The name of this clipboard object.

If the returned string is empty the clipboard instance ist the system clipboard.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.