offapi/com/sun/star/embed/XLinkFactory.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_XLinkFactory_idl__
  20 #define __com_sun_star_embed_XLinkFactory_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/embed/XStorage.idl>
  24 #include <com/sun/star/io/IOException.idl>
  25 #include <com/sun/star/embed/WrongStateException.idl>
  26 #include <com/sun/star/lang/IllegalArgumentException.idl>
  27 #include <com/sun/star/beans/PropertyValue.idl>
  28
  29
  30  module com {  module sun {  module star {  module embed {
  31
  32 /** allows to create and initialize a new link of specified type.
  33  */
  34 published interface XLinkFactory: com::sun::star::uno::XInterface
  35 {
  36     /** creates a new link and transport parameters for persistent
  37         initialization.
  38
  39         <p>
  40         This method can be used to have a full control over persistence
  41         initialization of a link.
  42         </p>
  43
  44         @param aClassID
  45             the class id of the new object
  46
  47         @param ClassName
  48             the class name of the new object
  49
  50         @param xStorage
  51             a parent storage the entry should be created in
  52
  53         @param sEntryName
  54             a name for the entry
  55
  56         @param aArgs
  57             com::sun::star::document::MediaDescriptor
  58             that contains source for the link
  59
  60         @param aObjectArgs
  61             optional parameters for the object persistence initialization
  62             see also
  63             com::sun::star::embed::EmbeddedObjectDescriptor
  64
  65         @throws ::com::sun::star::lang::IllegalArgumentException
  66             one of arguments is illegal
  67
  68         @throws com::sun::star::io::IOException
  69             in case of io problems during opening or creation
  70
  71         @throws com::sun::star::uno::Exception
  72             in case of other problems
  73      */
  74     ::com::sun::star::uno::XInterface createInstanceLinkUserInit(
  75             [in] sequence< byte > aClassID,
  76             [in] string ClassName,
  77             [in] ::com::sun::star::embed::XStorage xStorage,
  78             [in] string sEntryName,
  79             [in] sequence< ::com::sun::star::beans::PropertyValue > aArgs,
  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: */