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