interface XClipboardManager in module com::sun::star::datatransfer::clipboard::

(Global Index)

Syntax

interface XClipboardManager : com::sun::star::uno::XInterface ;

Description

This interface is used to retrieve, add, or remove clipboard instances.

See also

XClipboard

Method 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.

Known Services Which Export this Interface

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

Method Details



getClipboard

Syntax

com::sun::star::datatransfer::clipboard::XClipboard getClipboard (
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

Syntax

void addClipboard (
com::sun::star::datatransfer::clipboard::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

Syntax

void removeClipboard (
string aName );

Description

Removes the clipboard with the specified name from the list.

Parameter aName

The name of the clipboard to remove.

listClipboardNames

Syntax

sequence< string > listClipboardNames ();

Description

Get a list of a managed clipboards.

Returns

A sequence of the names of all available clipboards.
Top of Page