LibreOffice: com/sun/star/document/MediaDescriptor.idl Source File

LibreOffice LibreOffice 5.2 SDK API Reference

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List
- File Members

MediaDescriptor.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_document_MediaDescriptor_idl__
20 #define __com_sun_star_document_MediaDescriptor_idl__
21
22 #include <com/sun/star/io/XOutputStream.idl>
23 #include <com/sun/star/io/XInputStream.idl>
24 #include <com/sun/star/awt/Rectangle.idl>
25 #include <com/sun/star/beans/NamedValue.idl>
26 #include <com/sun/star/util/URL.idl>
27 #include <com/sun/star/task/XInteractionHandler.idl>
28 #include <com/sun/star/task/XStatusIndicator.idl>
29 #include <com/sun/star/frame/XFrame.idl>
30
31
32 module com { module sun { module star { module document {
33
55 service MediaDescriptor
56 {
60 [optional,property] boolean Aborted;
61
72 [optional,property] boolean AsTemplate;
73
81 [optional,property] string Author;
82
90 [optional,property] string CharacterSet;
91
99 [optional,property] string Comment;
100
114 [optional,property] any ComponentData;
115
118 [optional,property] string DocumentBaseURL;
119
126 [optional,property] string DocumentTitle;
127
142 [optional,property] sequence< ::com::sun::star::beans::NamedValue > EncryptionData;
143
152 [optional,property] string FileName;
153
164 [optional,property] string FilterName;
165
174 [optional,property] string FilterFlags;
175
185 [optional,property] string FilterOptions;
186
195 [optional,property] any FilterData;
196
204 [optional,property] boolean Hidden;
205
208 [optional,property] string HierarchicalDocumentName;
209
219 [optional,property] com::sun::star::io::XOutputStream OutputStream;
220
232 [optional,property] com::sun::star::io::XInputStream InputStream;
233
246 [optional,property] com::sun::star::task::XInteractionHandler InteractionHandler;
247
255 [optional,property] string JumpMark;
256
266 [optional,property] string MediaType;
267
304 [optional,property] string OpenFlags;
305
315 [optional,property] boolean OpenNewView;
316
317
325 [optional,property] boolean Overwrite;
326
337 [optional,property] string Password;
338
347 [optional,property] sequence< byte > PostData;
348
358 [optional,property] string PostString;
359
368 [optional,property] boolean Preview;
369
383 [optional,property] boolean ReadOnly;
384
392 [optional,property] boolean StartPresentation;
393
406 [optional,property] string Referer;
407
417 [optional,property] boolean RepairPackage;
418
429 [optional,property] com::sun::star::task::XStatusIndicator StatusIndicator;
430
438 [optional,property] string SuggestedSaveAsDir;
439
448 [optional,property] string SuggestedSaveAsName;
449
458 [optional,property] string TemplateName;
459
467 [optional,property] string TemplateRegionName;
468
477 [optional,property] boolean Unpacked;
478
485 [optional,property] string URL;
486
495 [optional,property] short Version;
496
505 [optional,property] any ViewData;
506
515 [optional,property] short ViewId;
516
523 [optional,property] short MacroExecutionMode;
524
531 [optional,property] short UpdateDocMode;
532
547 [optional,property] string ViewControllerName;
548
551 [optional,property] com::sun::star::frame::XFrame Frame;
552 };
553
554
555 }; }; }; };
556
557 #endif
558
559 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::document::MediaDescriptor::ComponentData
any ComponentData
pack specific properties of caller
Definition: MediaDescriptor.idl:114
com::sun::star::document::MediaDescriptor::FilterOptions
string FilterOptions
additional properties for filter
Definition: MediaDescriptor.idl:185
com::sun::star::document::MediaDescriptor::TemplateRegionName
string TemplateRegionName
name of the template instead of the URL
Definition: MediaDescriptor.idl:467
com::sun::star::document::MediaDescriptor::MacroExecutionMode
short MacroExecutionMode
should the macro be executed.
Definition: MediaDescriptor.idl:523
com::sun::star::document::MediaDescriptor::TemplateName
string TemplateName
name of the template instead of the URL
Definition: MediaDescriptor.idl:458
com::sun::star::document::MediaDescriptor::OpenNewView
boolean OpenNewView
opens a new view for an already loaded document
Definition: MediaDescriptor.idl:315
XInteractionHandler.idl
com::sun::star::document::MediaDescriptor::Frame
com::sun::star::frame::XFrame Frame
specifies the frame containing the document.
Definition: MediaDescriptor.idl:551
XOutputStream.idl
com
Definition: Ambiguous.idl:22
com::sun::star::document::MediaDescriptor::Unpacked
boolean Unpacked
regulate using of compressing
Definition: MediaDescriptor.idl:477
com::sun::star::document::MediaDescriptor::EncryptionData
sequence< ::com::sun::star::beans::NamedValue > EncryptionData
encryption information for encryption/decryption of documents
Definition: MediaDescriptor.idl:142
com::sun::star::document::MediaDescriptor::HierarchicalDocumentName
string HierarchicalDocumentName
The hierarchical path to the embedded document from topmost container.
Definition: MediaDescriptor.idl:208
com::sun::star::document::MediaDescriptor::UpdateDocMode
short UpdateDocMode
can the document be updated depending from links.
Definition: MediaDescriptor.idl:531
com::sun::star::document::MediaDescriptor::OpenFlags
string OpenFlags
please use the corresponding parameters of this descriptor instead
Definition: MediaDescriptor.idl:304
com::sun::star::task::XInteractionHandler
An interaction request handler.
Definition: XInteractionHandler.idl:32
com::sun::star::document::MediaDescriptor::StartPresentation
boolean StartPresentation
start presentation from a document
Definition: MediaDescriptor.idl:392
com::sun::star::document::MediaDescriptor::CharacterSet
string CharacterSet
identifier of used character set
Definition: MediaDescriptor.idl:90
com::sun::star::document::MediaDescriptor::SuggestedSaveAsDir
string SuggestedSaveAsDir
allows to specify the URL that is used next time SaveAs dialog is opened
Definition: MediaDescriptor.idl:438
com::sun::star::document::MediaDescriptor::FilterName
string FilterName
internal filter name
Definition: MediaDescriptor.idl:164
com::sun::star::document::MediaDescriptor::FilterData
any FilterData
additional properties for filter
Definition: MediaDescriptor.idl:195
com::sun::star::document::MediaDescriptor::Password
string Password
password for loading storing documents
Definition: MediaDescriptor.idl:337
com::sun::star::document::MediaDescriptor::PostData
sequence< byte > PostData
contains the data for HTTP post method as a sequence of bytes.
Definition: MediaDescriptor.idl:347
com::sun::star::document::MediaDescriptor
describes properties of a document, regarding the relationship between the loaded document and the re...
Definition: MediaDescriptor.idl:55
com::sun::star::document::MediaDescriptor::Preview
boolean Preview
show preview
Definition: MediaDescriptor.idl:368
com::sun::star::task::XStatusIndicator
controls a status indicator which displays progress of longer actions to the user ...
Definition: XStatusIndicator.idl:36
com::sun::star::document::MediaDescriptor::StatusIndicator
com::sun::star::task::XStatusIndicator StatusIndicator
can be used for status information
Definition: MediaDescriptor.idl:429
com::sun::star::document::MediaDescriptor::PostString
string PostString
use MediaDescriptor::PostData instead of this
Definition: MediaDescriptor.idl:358
com::sun::star::io::XOutputStream
This is the basic interface to write data to a stream.
Definition: XOutputStream.idl:37
com::sun::star::document::MediaDescriptor::RepairPackage
boolean RepairPackage
let the document be opened in repair mode
Definition: MediaDescriptor.idl:417
com::sun::star::document::MediaDescriptor::Version
short Version
storage version
Definition: MediaDescriptor.idl:495
com::sun::star::document::MediaDescriptor::Hidden
boolean Hidden
load document invisible
Definition: MediaDescriptor.idl:204
com::sun::star::document::MediaDescriptor::ViewData
any ViewData
set special view state
Definition: MediaDescriptor.idl:505
com::sun::star::document::MediaDescriptor::AsTemplate
boolean AsTemplate
document is a template
Definition: MediaDescriptor.idl:72
Rectangle.idl
com::sun::star::frame::XFrame
a frame object can be considered to be an "anchor" object where a component can be attached to...
Definition: XFrame.idl:43
com::sun::star::document::MediaDescriptor::FilterFlags
string FilterFlags
same as MediaDescriptor::FilterOptions
Definition: MediaDescriptor.idl:174
com::sun::star::document::MediaDescriptor::Aborted
boolean Aborted
May be set by filters or detection services if user has chosen to abort loading/saving, e.g.
Definition: MediaDescriptor.idl:60
com::sun::star::document::MediaDescriptor::Referer
string Referer
name of document referrer
Definition: MediaDescriptor.idl:406
com::sun::star::document::MediaDescriptor::Author
string Author
the author of the document
Definition: MediaDescriptor.idl:81
com::sun::star::document::MediaDescriptor::Comment
string Comment
description of document
Definition: MediaDescriptor.idl:99
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition: XInputStream.idl:37
com::sun::star::document::MediaDescriptor::ViewControllerName
string ViewControllerName
specifies the name of the view controller to create when loading a document
Definition: MediaDescriptor.idl:547
XStatusIndicator.idl
com::sun::star::document::MediaDescriptor::DocumentTitle
string DocumentTitle
document title
Definition: MediaDescriptor.idl:126
com::sun::star::document::MediaDescriptor::MediaType
string MediaType
specify mime type of content
Definition: MediaDescriptor.idl:266
com::sun::star::document::MediaDescriptor::SuggestedSaveAsName
string SuggestedSaveAsName
allows to specify the suggested file name that is used next time SaveAs dialog is opened ...
Definition: MediaDescriptor.idl:448
XFrame.idl
com::sun::star::document::MediaDescriptor::FileName
string FileName
same as MediaDescriptor::URL
Definition: MediaDescriptor.idl:152
NamedValue.idl
com::sun::star::document::MediaDescriptor::DocumentBaseURL
string DocumentBaseURL
The base URL of the document to be used to resolve relative links.
Definition: MediaDescriptor.idl:118
XInputStream.idl
com::sun::star::document::MediaDescriptor::ViewId
short ViewId
id of the initial view
Definition: MediaDescriptor.idl:515
com::sun::star::document::MediaDescriptor::JumpMark
string JumpMark
jump to a marked position after loading
Definition: MediaDescriptor.idl:255
com::sun::star::document::MediaDescriptor::ReadOnly
boolean ReadOnly
open document readonly
Definition: MediaDescriptor.idl:383
URL.idl
com::sun::star::document::MediaDescriptor::URL
string URL
URL of the document.
Definition: MediaDescriptor.idl:485
com::sun::star::document::MediaDescriptor::InteractionHandler
com::sun::star::task::XInteractionHandler InteractionHandler
handle exceptional situations
Definition: MediaDescriptor.idl:246
com::sun::star::document::MediaDescriptor::Overwrite
boolean Overwrite
overwrite any existing file
Definition: MediaDescriptor.idl:325
com::sun::star::document::MediaDescriptor::InputStream
com::sun::star::io::XInputStream InputStream
content of document
Definition: MediaDescriptor.idl:232
com::sun::star::document::MediaDescriptor::OutputStream
com::sun::star::io::XOutputStream OutputStream
a stream to receive the document data.
Definition: MediaDescriptor.idl:219