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