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 XClipboardManager
Description
This interface is used to retrieve, add, or remove clipboard instances.
See also
XClipboard

Methods' Summary
getClipboard Get a clipboard instance by name.  
addClipboard Add a clipboard instance to the manager's list.  
removeClipboard Removes the clipboard with the specified name from the list.  
listClipboardNames Get a list of a managed clipboards.  
Methods' Details
getClipboard
XClipboard
getClipboard( [in] string  aName )
raises( ::com::sun::star::container::NoSuchElementException );

Description
Get a clipboard instance by name.
Returns
The clipboard object with the specified name.
Parameter aName
The name of clipboard to return. To retrieve the default (system) clipboard, pass an empty string.
Throws
com::sun::star::container::NoSuchElementException if no clipboard with the specified name exists.
addClipboard
void
addClipboard( [in] XClipboard  xClipboard )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::ElementExistException );

Description
Add a clipboard instance to the manager's list.
Parameter xClipboard
The clipboard to add.
Throws
com::sun::star::IllegalArgumentException if xClipboard is not a valid clipboard.
Throws
com::sun::star::container::ElementExistsException if a clipboard with the name of xClipboard already exists.
removeClipboard
void
removeClipboard( [in] string  aName );

Description
Removes the clipboard with the specified name from the list.
Parameter aName
The name of the clipboard to remove.
listClipboardNames
sequence< string >
listClipboardNames();

Description
Get a list of a managed clipboards.
Returns
A sequence of the names of all available clipboards.
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.