Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

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

interface XClipboard

Base Interface
com::sun::star::uno::XInterface



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::clipboard::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::clipboard::XTransferable xTrans,
[ in ] com::sun::star::datatransfer::clipboard::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 XTransferable has no 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
See also
com::sun::star::datatransfer::clipboard::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