Overview | Module | Use | Devguide | Index

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

:: 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

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.