/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
*
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_document_MediaDescriptor_idl__
#define __com_sun_star_document_MediaDescriptor_idl__
#ifndef __com_sun_star_io_XOutputStream_idl__
#include
#endif
#ifndef __com_sun_star_io_XInputStream_idl__
#include
#endif
#ifndef __com_sun_star_awt_Rectangle_idl__
#include
#endif
#ifndef __com_sun_star_beans_NamedValue_idl__
#include
#endif
#ifndef __com_sun_star_util_URL_idl__
#include
#endif
#ifndef __com_sun_star_task_XInteractionHandler_idl__
#include
#endif
#ifndef __com_sun_star_task_XStatusIndicator_idl__
#include
#endif
#ifndef __com_sun_star_frame_XFrame_idl__
#include
#endif
//=============================================================================
module com { module sun { module star { module document {
//=============================================================================
/** describes properties of a document, regarding the relationship
between the loaded document and the resource the document is
loaded from / stored to.
This service may be represented by a
PropertyValue.
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 if to actualize the informations about the document.
So this descriptor should be used as an in/out parameter.
Note:
It's not allowed to hold member of this descriptor by references longer than they
will be used (especially a possible stream). It's allowed to use it directly
or by copying it only.
@see com::sun::star::beans::PropertyValue
*/
published service MediaDescriptor
{
//-------------------------------------------------------------------------
/** May be set by filters or detection services if user has chosen to
abort loading/saving, e.g. while entering a password.
*/
[optional,property] boolean Aborted;
//-------------------------------------------------------------------------
/** document is a template
Loading a component of type "template" creates a new untitled document
by default, but setting the "AsTemplate" property to loads the
template document for editing. Setting "AsTemplate" to creates a
new untitled document out of the loaded document, even if it has not
a "template" type.
*/
[optional,property] boolean AsTemplate;
//-------------------------------------------------------------------------
/** the author of the document
Only for storing versions in components supporting versioning:
author of version.
*/
[optional,property] string Author;
//-------------------------------------------------------------------------
/** identifier of used character set
Defines the character set for document formats that contain single
byte characters (if necessary).
*/
[optional,property] string CharacterSet;
//-------------------------------------------------------------------------
/** description of document
Only for storing versions in components supporting versioning:
comment (description) for stored version.
*/
[optional,property] string Comment;
//-------------------------------------------------------------------------
/** pack specific properties of caller
This is a parameter that can be used for any properties specific
for a special component type. Format of that depends from real
type of addressed component.
For extensibility, it is recommended to use values of type
sequence with this property.
*/
[optional,property] any ComponentData;
//-------------------------------------------------------------------------
/** The base URL of the document to be used to resolve relative links.
*/
[optional,property] string DocumentBaseURL;
//-------------------------------------------------------------------------
/** document title
This parameter can be used to specify a title for a document.
*/
[optional,property] string DocumentTitle;
//-------------------------------------------------------------------------
/** encryption information for encryption/decryption of documents
It contains the necessary information for encryption/decryption of
a component (if necessary).
If neither password nor encryption data is specified, loading of
a password protected document will fail, storing will be done without
encryption. If both are provided, the encryption data is used
( if the filter supports it ).
The encryption data is generated based on the password.
*/
[optional,property] sequence< ::com::sun::star::beans::NamedValue > EncryptionData;
//-------------------------------------------------------------------------
/** same as MediaDescriptor::URL
It will be supported for compatibility reasons only.
@deprecated
*/
[optional,property] string FileName;
//-------------------------------------------------------------------------
/** internal filter name
Name of a filter that should be used for loading or storing the component.
Names must match the names of the TypeDetection configuration,
invalid names are ignored. If a name is specified on loading,
it still will be verified by a filter detection, but in case of doubt
it will be preferred.
*/
[optional,property] string FilterName;
//-------------------------------------------------------------------------
/** same as MediaDescriptor::FilterOptions
It will be supported for compatibility reasons only.
@deprecated
*/
[optional,property] string FilterFlags;
//-------------------------------------------------------------------------
/** additional properties for filter
Some filters need additional parameters; use only together with property
MediaDescriptor::FilterName. Details must be documented
by the filter. This is an old format for some filters. If a string is not
enough, filters can use the property MediaDescriptor::FilterData.
*/
[optional,property] string FilterOptions;
//-------------------------------------------------------------------------
/** additional properties for filter
This is a parameter that can be used for any properties specific
for a special filter type. It should be used if
MediaDescriptor::FilterOptions isn't enough.
*/
[optional,property] any FilterData;
//-------------------------------------------------------------------------
/** load document invisible
Defines if the loaded component is made visible. If this property is not
specified, the component is made visible by default.
*/
[optional,property] boolean Hidden;
//-------------------------------------------------------------------------
/** The hierarchical path to the embedded document from topmost container.
*/
[optional,property] string HierarchicalDocumentName;
//-------------------------------------------------------------------------
/** a stream to receive the document data.
If used when storing a document: writing must be done using this stream.
If no stream is provided, the loader will create a stream by itself using
the other properties. It is not allowed to keep a reference to this
OutputStream after storing the component.
*/
[optional,property] com::sun::star::io::XOutputStream OutputStream;
//-------------------------------------------------------------------------
/** content of document
If used when loading a document: reading must be done using this stream.
If no stream is provided, the loader will create a stream by itself using
the other properties. It is not allowed to keep a reference to this
InputStream after loading the component, and it would be useless, because
in general an InputStream is usable for reading only once, except when it
also implements the XSeekable interface.
*/
[optional,property] com::sun::star::io::XInputStream InputStream;
//-------------------------------------------------------------------------
/** handle exceptional situations
Object implementing the InteractionHandler
service that is used to handle exceptional situations where proceeding with the task
is impossible without additional information or impossible at all.
The implemented API provides a default implementation for it that can handle many situations.
If no InteractionHandler is set, a suitable exception is thrown.
It is not allowed to keep a reference to this object, even not in the loaded
or stored component's copy of the MediaDescriptor provided by its arguments attribute.
*/
[optional,property] com::sun::star::task::XInteractionHandler InteractionHandler;
//-------------------------------------------------------------------------
/** jump to a marked position after loading
This is the same as the text behind a "#" in a http URL. But
this syntax with a "#" is not specified in most URL schemas.
*/
[optional,property] string JumpMark;
//-------------------------------------------------------------------------
/** specify mime type of content
Type of the medium to load, that must match to one of the types defined
in the TypeDetection configuration (otherwise it's ignored).
This bypasses the type detection of the Desktop environment,
so passing a wrong MediaType will cause failure of loading.
*/
[optional,property] string MediaType;
//-------------------------------------------------------------------------
/** please use the corresponding parameters of this descriptor instead
String that summarizes some flags for loading. The string contains capital
letters for the flags:
flag |
value |
replacement |
ReadOnly |
R |
MediaDescriptor::ReadOnly |
Preview |
B |
MediaDescriptor::Preview |
AsTemplate |
T |
MediaDescriptor::AsTemplate |
Hidden |
H |
MediaDescriptor::Hidden |
@deprecated
*/
[optional,property] string OpenFlags;
//-------------------------------------------------------------------------
/** opens a new view for an already loaded document
Setting this to forces the component to create a new window on loading
in any case. If the component supports multiple views, a second view is
opened, if not, the component is loaded one more time. Otherwise the behavior
depends on the default window handling of the Desktop environment.
*/
[optional,property] boolean OpenNewView;
//-------------------------------------------------------------------------
/** overwrite any existing file
For storing only: overwrite any existing file, default is ,
so an error occurs if the target file already exists.
*/
[optional,property] boolean Overwrite;
//-------------------------------------------------------------------------
/** password for loading storing documents
It contains a password for loading or storing a component (if necessary).
If neither password nor encryption data is specified, loading of
a password protected document will fail, storing will be done without
encryption. If both are provided, the encryption data is used
( if the filter supports it ).
*/
[optional,property] string Password;
//-------------------------------------------------------------------------
/** contains the data for HTTP post method as a sequence of bytes.
Data to send to a location described by the media descriptor to get
a result in return that will be loaded as a component
(usually in webforms). Default is: no PostData.
*/
[optional,property] sequence< byte > PostData;
//-------------------------------------------------------------------------
/** use MediaDescriptor::PostData instead of this
Same as PostData, but the data is transferred as a string
(just for compatibility).
@deprecated
*/
[optional,property] string PostString;
//-------------------------------------------------------------------------
/** show preview
Setting this to tells the a loaded component that it is loaded as
a preview, so it can optimize loading and viewing for this special purpose.
Default is .
*/
[optional,property] boolean Preview;
//-------------------------------------------------------------------------
/** open document readonly
Tells whether a document should be loaded in a (logical) readonly or in
read/write mode. If opening in the desired mode is impossible, an error occurs.
By default the loaded content decides what to do: if its UCB content supports
a "readonly" property, the logical open mode depends on that, otherwise
it will be read/write. This is only a UI related property, opening a
document in read only mode will not prevent the component from being
modified by API calls, but all modifying functionality in the UI will
be disabled or removed.
*/
[optional,property] boolean ReadOnly;
//-------------------------------------------------------------------------
/** start presentation from a document
Tells the component loading the document that a presentation that is in the
document is to be started right away.
*/
[optional,property] boolean StartPresentation;
//-------------------------------------------------------------------------
/** name of document referrer
A URL describing the environment of the request; e.g. a referrer may be a
URL of a document, if a hyperlink inside this document is clicked to load
another document. The referrer may be evaluated by the addressed UCB content
or the loaded document. Without a referrer the processing of URLs that
needs security checks will be denied, e.g. "macro:" URLs.
Don't be confused about the wrong spelling; it is kept for compatibility reasons.
*/
[optional,property] string Referer;
//-------------------------------------------------------------------------
/** let the document be opened in repair mode
For loading of corrupted zip packages: Setting this to let the document
be opened in repair mode, so as much as possible information will be retrieved.
@since OOo 1.1.2
*/
[optional,property] boolean RepairPackage;
//-------------------------------------------------------------------------
/** can be used for status informations
Object implementing the XStatusIndicator
interface that can be used to give status information (text or progress) for the task.
The office provides a default implementation for it. It is not allowed to keep
a reference to this object, even not in the loaded or stored component's
copy of the MediaDescriptor provided by its arguments attribute.
*/
[optional,property] com::sun::star::task::XStatusIndicator StatusIndicator;
//-------------------------------------------------------------------------
/** allows to specify the URL that is used next time SaveAs dialog is opened
If the parameter is specified, the URL will be used by SaveAs dialog
next time as target folder.
*/
[optional,property] string SuggestedSaveAsDir;
//-------------------------------------------------------------------------
/** allows to specify the suggested file name that is used next time SaveAs
dialog is opened
If the parameter is specified, the file name will be suggested by
SaveAs dialog next time.
*/
[optional,property] string SuggestedSaveAsName;
//-------------------------------------------------------------------------
/** name of the template instead of the URL
The logical name of a template to load. Together with the MediaDescriptor::TemplateRegion
property it can be used instead of the URL of the template. Use always in conjunction with
MediaDescriptor::TemplateRegionName.
*/
[optional,property] string TemplateName;
//-------------------------------------------------------------------------
/** name of the template instead of the URL
The logical name of a template to load. Together with the MediaDescriptor::TemplateRegion
property it can be used instead of the URL of the template. Use always in conjunction with
MediaDescriptor::TemplateRegionName.
*/
[optional,property] string TemplateRegionName;
//-------------------------------------------------------------------------
/** regulate using of compressing
For storing: Setting this to means, don't use a zip file to save
the document, use a folder instead (only usable for UCB contents, that
support folders). Default is .
*/
[optional,property] boolean Unpacked;
//-------------------------------------------------------------------------
/** URL of the document
The location of the component in URL syntax. It must be the full qualified URL and
*/
[optional,property] string URL;
//-------------------------------------------------------------------------
/** storage version
For components supporting versioning: the number of the version to be
loaded or saved. Default is zero and means: no version is created or
loaded, the "main" document is processed.
*/
[optional,property] short Version;
//-------------------------------------------------------------------------
/** set special view state
Data to set a special view state after loading. The type depends on
the component and is usually retrieved from a Controller
object by its XController
interface. Default is: no view data.
*/
[optional,property] any ViewData;
//-------------------------------------------------------------------------
/** id of the initial view
For components supporting different views: a number to define the view
that should be constructed after loading. Default is: zero, and this
should be treated by the component as the default view.
*/
[optional,property] short ViewId;
//-------------------------------------------------------------------------
/** should the macro be executed.
the value should be one from MacroExecMode
constant list.
@since OOo 1.1.2
*/
[optional,property] short MacroExecutionMode;
//-------------------------------------------------------------------------
/** can the document be updated depending from links.
the value should be one from UpdateDocMode
constant list.
@since OOo 1.1.2
*/
[optional,property] short UpdateDocMode;
//-------------------------------------------------------------------------
/** specifies the name of the view controller to create when loading a document
If this property is used when loading a document into a frame, then it
specifies the name of the view controller to create. That is, the property
is passed to the document's XModel2::createViewController
method.
If the loaded document does not support the XModel2
interface,
the property is ignored.
@see ::com::sun::star::frame::XModel2::createViewController
@see ::com::sun::star::frame::XController2::ViewControllerName
@since OOo 3.0
*/
[optional,property] string ViewControllerName;
//-------------------------------------------------------------------------
/** specifies the frame containing the document. May be empty.
*/
[optional,property] com::sun::star::frame::XFrame Frame;
};
//=============================================================================
}; }; }; };
#endif