LibreOffice
LibreOffice 6.4 SDK API Reference
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 #ifndef __com_sun_star_embed_XEmbedPersist_idl__
20 #define __com_sun_star_embed_XEmbedPersist_idl__
21 
29 
30 
31  module com { module sun { module star { module embed {
32 
40 published interface XEmbedPersist: XCommonEmbedPersist
41 {
96  [in] ::com::sun::star::embed::XStorage xStorage,
97  [in] string sEntName,
98  [in] long nEntryConnectionMode,
99  [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
100  [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
105 
136  [in] ::com::sun::star::embed::XStorage xStorage,
137  [in] string sEntName,
138  [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
139  [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
144 
185  [in] ::com::sun::star::embed::XStorage xStorage,
186  [in] string sEntName,
187  [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
188  [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
193 
194 
209  void saveCompleted( [in] boolean bUseNew )
212 
219  boolean hasEntry()
220  raises( ::com::sun::star::embed::WrongStateException );
221 
230  string getEntryName()
231  raises( ::com::sun::star::embed::WrongStateException );
232 };
233 
234 
235 }; }; }; };
236 
237 #endif
238 
239 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XInterface.idl
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
specifies an implementation for embedded object persistence.
Definition: XEmbedPersist.idl:41
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:33
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::hasEntry
boolean hasEntry()
allows to detect if the object has entry.
XCommonEmbedPersist.idl
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::XStorage
This interface represents main storage functionality.
Definition: XStorage.idl:44
WrongStateException.idl
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::io::IOException
is thrown when an input or output error has occurred.
Definition: IOException.idl:31
PropertyValue.idl
com::sun::star::embed::XCommonEmbedPersist
specifies common implementation for embedded objects and links persistence.
Definition: XCommonEmbedPersist.idl:36
com::sun::star::uno::Exception
the base of all UNO exceptions
Definition: Exception.idl:33
IOException.idl
com
Definition: Ambiguous.idl:22
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
XStorage.idl
IllegalArgumentException.idl