offapi/com/sun/star/datatransfer/clipboard/XClipboardFactory.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_XClipboardFactory_idl__
  21 #define __com_sun_star_datatransfer_clipboard_XClipboardFactory_idl__
  22
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24 #include <com/sun/star/uno/XInterface.idl>
  25
  26
  27 module com { module sun { module star { module datatransfer { module clipboard {
  28
  29  published interface XClipboard;
  30
  31 /** Should be implemented by a clipboard factory that simplifies the creation of
  32     multiple clipboard instances.
  33
  34     @see com::sun::star::datatransfer::clipboard::XClipboard
  35 */
  36
  37 published interface XClipboardFactory: com::sun::star::uno::XInterface
  38 {
  39     /** Creates a new named clipboard instance.
  40
  41         @returns
  42         A newly created instance of a GenericClipboard
  43         implementation.
  44
  45         @param aName
  46         The name the clipboard should have.
  47
  48         @throws com::sun::star::lang::IllegalArgumentException
  49         If an empty string is passed as clipboard name.
  50     */
  51     XClipboard createClipboard( [in] string aName )
  52         raises ( com::sun::star::lang::IllegalArgumentException );
  53 };
  54
  55
  56 }; }; }; }; };
  57
  58 #endif
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */