Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: datatransfer :: clipboard ::
interface XClipboardManager
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-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 raises( | aName ) ::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 raises( | xClipboard ) ::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

Copyright © 2003 Sun Microsystems, Inc.