offapi/com/sun/star/embed/XEmbedObjectClipboardCreator.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 embed {
  22
  23 /** allows to create and initialize a new embedded object from clipboard.
  24
  25     <p>
  26     This interface contains methods that can help to create and initialize
  27     an embedded object based on system clipboard.
  28     </p>
  29  */
  30 published interface XEmbedObjectClipboardCreator: com::sun::star::uno::XInterface
  31 {
  32     /** creates a new object and initializes it from the system clipboard.
  33
  34         <p> In case specified entry exists it's contents are ignored and
  35         will be overwritten on storing.
  36         </p>
  37
  38         <p>
  39         The clipboard can provide a number of choices that are container
  40         related. This information will be returned in the
  41         InsertedObjectInfo object.
  42         <p>
  43
  44         @param xStorage
  45             a parent storage the entry should be created/opened in
  46
  47         @param sEntryName
  48             a name for the entry
  49
  50         @param aObjectArgs
  51             optional parameters for the object persistence initialization
  52             see also
  53             EmbeddedObjectDescriptor
  54
  55         @returns
  56             the structure containing the object and container related options
  57
  58         @throws ::com::sun::star::lang::IllegalArgumentException
  59             one of arguments is illegal
  60
  61         @throws com::sun::star::io::IOException
  62             in case of io problems during opening or creation
  63
  64         @throws com::sun::star::uno::Exception
  65             in case of other problems
  66      */
  67     InsertedObjectInfo createInstanceInitFromClipboard(
  68             [in] ::com::sun::star::embed::XStorage xStorage,
  69              [in] string sEntryName,
  70             [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
  71         raises( ::com::sun::star::lang::IllegalArgumentException,
  72                 ::com::sun::star::io::IOException,
  73                 ::com::sun::star::uno::Exception );
  74 };
  75
  76
  77 }; }; }; };
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */