1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
module com { module sun { module star { module embed {
/** allows to create and initialize a new embedded object.
<p>
This interface contains methods that can help to create and initialize
an embedded object.
</p>
*/
published interface XEmbedObjectCreator: com::sun::star::uno::XInterface
{
/** creates a new object and initializes it as a new one.
<p> In case specified entry exists it's contents are ignored and
will be overwritten on storing.
</p>
@param aClassID
the class id of the new object
@param sClassName
the class name of the new object
@param xStorage
a parent storage the entry should be created/opened in
@param sEntryName
a name for the entry
@param aObjectArgs
optional parameters for the object persistence initialization
see also
EmbeddedObjectDescriptor
@throws ::com::sun::star::lang::IllegalArgumentException
one of arguments is illegal
@throws com::sun::star::io::IOException
in case of io problems during opening or creation
@throws com::sun::star::uno::Exception
in case of other problems
*/
::com::sun::star::uno::XInterface createInstanceInitNew(
[in] sequence< byte > aClassID,
[in] string sClassName,
[in] ::com::sun::star::embed::XStorage xStorage,
[in] string sEntryName,
[in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::io::IOException,
::com::sun::star::uno::Exception );
/** creates a new object that should be based on specified storage entry.
<p> The specified entry must exists and the object should be loaded
from the entry. In case a persistent representation of a link is
specified, the result object will be a link.
</p>
@param xStorage
a parent storage the entry should be opened in
@param sEntryName
a name for the entry
@param aMediaDescriptor
an object of type
com::sun::star::document::MediaDescriptor that
specifies document related properties; please remember that target
related parameters, for example URL, will be ignored since the
object should be loaded from storage entry
@param aObjectArgs
an object of type EmbeddedObjectDescriptor
contains object related properties
@throws ::com::sun::star::lang::IllegalArgumentException
one of arguments is illegal
@throws ::com::sun::star::container::NoSuchElementException
the specified entry does not exist
@throws com::sun::star::io::IOException
in case of io problems during opening
@throws com::sun::star::uno::Exception
in case of other problems
*/
::com::sun::star::uno::XInterface createInstanceInitFromEntry(
[in] ::com::sun::star::embed::XStorage xStorage,
[in] string sEntryName,
[in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor,
[in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::io::IOException,
::com::sun::star::uno::Exception );
/** creates a new object and initializes it based on
com::sun::star::document::MediaDescriptor.
<p> In case specified entry exists it's contents are ignored and will
be overwritten on storing.
</p>
@param xStorage
a parent storage the entry should be created/opened in
@param sEntryName
a name for the entry
@param aMediaDescriptor
an object of type
com::sun::star::document::MediaDescriptor that
specifies source
@param aObjectArgs
an object of type EmbeddedObjectDescriptor
contains object related properties
@throws ::com::sun::star::lang::IllegalArgumentException
one of arguments is illegal
@throws com::sun::star::io::IOException
in case of io problems during opening or creation
@throws com::sun::star::uno::Exception
in case of other problems
*/
::com::sun::star::uno::XInterface createInstanceInitFromMediaDescriptor(
[in] ::com::sun::star::embed::XStorage xStorage,
[in] string sEntryName,
[in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor,
[in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::io::IOException,
::com::sun::star::uno::Exception );
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|