LibreOffice: com/sun/star/embed/XEmbedPersist.idl Source File

LibreOffice LibreOffice 25.8 SDK API Reference

Loading...
Searching...
No Matches
XEmbedPersist.idl
Go to the documentation of this file.
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
30published interface XEmbedPersist: XCommonEmbedPersist
31{
85 void setPersistentEntry(
86 [in] ::com::sun::star::embed::XStorage xStorage,
87 [in] string sEntName,
88 [in] long nEntryConnectionMode,
89 [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
90 [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
91 raises( ::com::sun::star::lang::IllegalArgumentException,
92 ::com::sun::star::embed::WrongStateException,
93 ::com::sun::star::io::IOException,
94 ::com::sun::star::uno::Exception );
95
125 void storeToEntry(
126 [in] ::com::sun::star::embed::XStorage xStorage,
127 [in] string sEntName,
128 [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
129 [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
130 raises( ::com::sun::star::lang::IllegalArgumentException,
131 ::com::sun::star::embed::WrongStateException,
132 ::com::sun::star::io::IOException,
133 ::com::sun::star::uno::Exception );
134
174 void storeAsEntry(
175 [in] ::com::sun::star::embed::XStorage xStorage,
176 [in] string sEntName,
177 [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
178 [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
179 raises( ::com::sun::star::lang::IllegalArgumentException,
180 ::com::sun::star::embed::WrongStateException,
181 ::com::sun::star::io::IOException,
182 ::com::sun::star::uno::Exception );
183
184
198
199 void saveCompleted( [in] boolean bUseNew )
200 raises( ::com::sun::star::embed::WrongStateException,
201 ::com::sun::star::uno::Exception );
202
209 boolean hasEntry()
210 raises( ::com::sun::star::embed::WrongStateException );
211
220 string getEntryName()
221 raises( ::com::sun::star::embed::WrongStateException );
222};
223
224
225}; }; }; };
226
227/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::embed::WrongStateException
This exception can be thrown in case the object's state does not allow to call requested functionalit...
Definition WrongStateException.idl:29
com::sun::star::io::IOException
is thrown when an input or output error has occurred.
Definition IOException.idl:27
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition IllegalArgumentException.idl:27
com::sun::star::uno::Exception
the base of all UNO exceptions
Definition Exception.idl:29
com::sun::star::embed::XCommonEmbedPersist
specifies common implementation for embedded objects and links persistence.
Definition XCommonEmbedPersist.idl:27
com::sun::star::embed::XEmbedPersist
specifies an implementation for embedded object persistence.
Definition XEmbedPersist.idl:31
com::sun::star::embed::XEmbedPersist::saveCompleted
void saveCompleted([in] boolean bUseNew)
specifies whether the object should use an old storage or a new one after "save as" operation.
com::sun::star::embed::XEmbedPersist::setPersistentEntry
void setPersistentEntry([in] ::com::sun::star::embed::XStorage xStorage, [in] string sEntName, [in] long nEntryConnectionMode, [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs, [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs)
provides object with a parent storage and a name for object's entry.
com::sun::star::embed::XEmbedPersist::storeToEntry
void storeToEntry([in] ::com::sun::star::embed::XStorage xStorage, [in] string sEntName, [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs, [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs)
lets the object store itself to an entry in destination storage, the own persistence entry is not cha...
com::sun::star::embed::XEmbedPersist::hasEntry
boolean hasEntry()
allows to detect if the object has entry.
com::sun::star::embed::XEmbedPersist::getEntryName
string getEntryName()
allows to retrieve the current object entry name.
com::sun::star::embed::XEmbedPersist::storeAsEntry
void storeAsEntry([in] ::com::sun::star::embed::XStorage xStorage, [in] string sEntName, [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs, [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs)
lets the object store itself to an entry in destination storage and prepare to use the new entry for ...
com::sun::star::embed::XStorage
This interface represents main storage functionality.
Definition XStorage.idl:27
com::sun::star::embed
interfaces related to embedded objects, both native UNO and OLE.
Definition Actions.idl:21
com::sun::star
the module com::sun::star is the root module of the UNO API.
Definition Ambiguous.idl:20
com::sun
Definition Ambiguous.idl:20
com
Definition Ambiguous.idl:20