offapi/com/sun/star/datatransfer/clipboard/XClipboardManager.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module datatransfer { module clipboard {
  22
  23  published interface XClipboard;
  24
  25 /** This interface is used to retrieve, add, or remove clipboard instances.
  26
  27     @see com::sun::star::datatransfer::clipboard::XClipboard
  28 */
  29
  30 published interface XClipboardManager: com::sun::star::uno::XInterface
  31 {
  32     /** Get a clipboard instance by name.
  33
  34         @returns
  35         The clipboard object with the specified name.
  36
  37         @param aName
  38         The name of clipboard to return. To retrieve the default (system)
  39         clipboard, pass an empty string.
  40
  41         @throws com::sun::star::container::NoSuchElementException
  42         if no clipboard with the specified name exists.
  43     */
  44     XClipboard getClipboard( [in] string aName )
  45         raises ( com::sun::star::container::NoSuchElementException );
  46
  47     /** Add a clipboard instance to the manager's list.
  48
  49         @param xClipboard
  50         The clipboard to add.
  51
  52         @throws com::sun::star::IllegalArgumentException
  53         if xClipboard is not a valid clipboard.
  54
  55         @throws com::sun::star::container::ElementExistsException
  56         if a clipboard with the name of xClipboard already exists.
  57     */
  58     void addClipboard( [in] XClipboard xClipboard )
  59         raises ( com::sun::star::lang::IllegalArgumentException,
  60                  com::sun::star::container::ElementExistException );
  61
  62     /** Removes the clipboard with the specified name from the list.
  63
  64         @param aName
  65         The name of the clipboard to remove.
  66     */
  67     void removeClipboard( [in] string aName );
  68
  69     /** Get a list of a managed clipboards.
  70
  71         @returns
  72         A sequence of the names of all available clipboards.
  73      */
  74     sequence < string > listClipboardNames();
  75 };
  76
  77
  78 }; }; }; }; };
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */