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 #ifndef __com_sun_star_datatransfer_clipboard_XClipboardManager_idl__
  21 #define __com_sun_star_datatransfer_clipboard_XClipboardManager_idl__
  22
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24 #include <com/sun/star/container/ElementExistException.idl>
  25 #include <com/sun/star/container/NoSuchElementException.idl>
  26 #include <com/sun/star/uno/XInterface.idl>
  27
  28
  29 module com { module sun { module star { module datatransfer { module clipboard {
  30
  31  published interface XClipboard;
  32
  33 /** This interface is used to retrieve, add, or remove clipboard instances.
  34
  35     @see com::sun::star::datatransfer::clipboard::XClipboard
  36 */
  37
  38 published interface XClipboardManager: com::sun::star::uno::XInterface
  39 {
  40     /** Get a clipboard instance by name.
  41
  42         @returns
  43         The clipboard object with the specified name.
  44
  45         @param aName
  46         The name of clipboard to return. To retrieve the default (system)
  47         clipboard, pass an empty string.
  48
  49         @throws com::sun::star::container::NoSuchElementException
  50         if no clipboard with the specified name exists.
  51     */
  52     XClipboard getClipboard( [in] string aName )
  53         raises ( com::sun::star::container::NoSuchElementException );
  54
  55     /** Add a clipboard instance to the manager's list.
  56
  57         @param xClipboard
  58         The clipboard to add.
  59
  60         @throws com::sun::star::IllegalArgumentException
  61         if xClipboard is not a valid clipboard.
  62
  63         @throws com::sun::star::container::ElementExistsException
  64         if a clipboard with the name of xClipboard already exists.
  65     */
  66     void addClipboard( [in] XClipboard xClipboard )
  67         raises ( com::sun::star::lang::IllegalArgumentException,
  68                  com::sun::star::container::ElementExistException );
  69
  70     /** Removes the clipboard with the specified name from the list.
  71
  72         @param aName
  73         The name of the clipboard to remove.
  74     */
  75     void removeClipboard( [in] string aName );
  76
  77     /** Get a list of a managed clipboards.
  78
  79         @returns
  80         A sequence of the names of all available clipboards.
  81      */
  82     sequence < string > listClipboardNames();
  83 };
  84
  85
  86 }; }; }; }; };
  87
  88 #endif
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */