diff options
Diffstat (limited to 'offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl')
-rw-r--r-- | offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl b/offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl new file mode 100644 index 000000000..02ff3adf5 --- /dev/null +++ b/offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl @@ -0,0 +1,84 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_embed_EmbeddedObjectDescriptor_idl__ +#define __com_sun_star_embed_EmbeddedObjectDescriptor_idl__ + +#include <com/sun/star/io/XInputStream.idl> +#include <com/sun/star/awt/Rectangle.idl> +#include <com/sun/star/util/URL.idl> +#include <com/sun/star/task/XInteractionHandler.idl> +#include <com/sun/star/task/XStatusIndicator.idl> +#include <com/sun/star/frame/XDispatchProviderInterceptor.idl> +#include <com/sun/star/embed/XStorage.idl> + + +module com { module sun { module star { module embed { + +/** describes properties of an embedded object + + <p> + This service may be represented by a + com::sun::star::beansPropertyValue[]. + Such descriptors will be passed to different functions, included into + possible load/save processes. Every member of such process can use + this descriptor and may change it to actualize the information about + the object. So this descriptor should be used as an in/out parameter. + </p> + + @see com::sun::star::beans::PropertyValue + */ +published service EmbeddedObjectDescriptor +{ + /** lets the graphical representation of embedded document be stored. + + <p> + Setting of this property to true tells the embedded object that + controls the document to store or not to store the graphical + representation of the document into the object persistence. + If this property is not set the object makes the decision itself. + </p> + */ + [optional,property] boolean StoreVisualReplacement; + + /** allows to provide a dispatch interceptor for outplace activation. + */ + [optional,property] ::com::sun::star::frame::XDispatchProviderInterceptor + OutplaceDispatchInterceptor; + + /** denotes the storage from which the embedded object is to be recovered. + + <p>Upon activating the embedded object, it is normally loaded from a storage as denoted by + the parameters to the XEmbedObjectCreator method calls.</p> + + <p>You can pass a non-`NULL` <code>RecoveryStorage</code> in the object descriptor if you wish to load the + embedded object from an alternate storage.</p> + + <p>The object will still be based on the storage denoted in the <code>XEmbedObjectCreator</code> method + call, i.e., subsequent save operations will still use that storage. <code>RecoveryStorage</code> is used + at loading time only, and then discarded.</p> + */ + [optional, property] XStorage RecoveryStorage; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |