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