LibreOfficeDev
LibreOfficeDev 25.8 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 
20 
21 module com { module sun { module star { module document {
22 
45 {
49  [optional,property] boolean Aborted;
50 
61  [optional,property] boolean AsTemplate;
62 
70  [optional,property] string Author;
71 
79  [optional,property] string CharacterSet;
80 
88  [optional,property] string Comment;
89 
103  [optional,property] any ComponentData;
104 
107  [optional,property] string DocumentBaseURL;
108 
115  [optional,property] string DocumentTitle;
116 
131  [optional,property] sequence< ::com::sun::star::beans::NamedValue > EncryptionData;
132 
141  [optional,property] string FileName;
142 
155  [optional,property] string FilterName;
156 
165  [optional,property] string FilterFlags;
166 
176  [optional,property] string FilterOptions;
177 
186  [optional,property] any FilterData;
187 
195  [optional,property] boolean Hidden;
196 
199  [optional,property] string HierarchicalDocumentName;
200 
211 
224 
238 
246  [optional,property] string JumpMark;
247 
257  [optional,property] string MediaType;
258 
295  [optional,property] string OpenFlags;
296 
306  [optional,property] boolean OpenNewView;
307 
308 
316  [optional,property] boolean Overwrite;
317 
328  [optional,property] string Password;
329 
338  [optional,property] sequence< byte > PostData;
339 
349  [optional,property] boolean PickListEntry;
350 
360  [optional,property] string PostString;
361 
370  [optional,property] boolean Preview;
371 
385  [optional,property] boolean ReadOnly;
386 
394  [optional,property] boolean StartPresentation;
395 
408  [optional,property] string Referer;
409 
419  [optional,property] boolean RepairPackage;
420 
432 
440  [optional,property] string SuggestedSaveAsDir;
441 
450  [optional,property] string SuggestedSaveAsName;
451 
455  [optional,property] string ExportDirectory;
456 
465  [optional,property] string TemplateName;
466 
474  [optional,property] string TemplateRegionName;
475 
484  [optional,property] boolean Unpacked;
485 
492  [optional,property] string URL;
493 
502  [optional,property] short Version;
503 
512  [optional,property] any ViewData;
513 
522  [optional,property] short ViewId;
523 
530  [optional,property] short MacroExecutionMode;
531 
538  [optional,property] short UpdateDocMode;
539 
554  [optional,property] string ViewControllerName;
555 
559 
566  [optional,property] boolean LockContentExtraction;
567 
574  [optional,property] boolean LockExport;
575 
580  [optional,property] boolean LockPrint;
581 
586  [optional,property] boolean LockSave;
587 
592  [optional,property] boolean LockEditDoc;
593 
605  [optional,property] boolean Replaceable;
606 };
607 
608 
609 }; }; }; };
610 
611 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
boolean LockSave
Setting this option will disable the save function.
Definition: MediaDescriptor.idl:586
boolean LockPrint
Setting this option will disable all print functions (including Printer setup)
Definition: MediaDescriptor.idl:580
any ComponentData
pack specific properties of caller
Definition: MediaDescriptor.idl:103
string FilterOptions
additional properties for filter
Definition: MediaDescriptor.idl:176
string TemplateRegionName
name of the template instead of the URL
Definition: MediaDescriptor.idl:474
short MacroExecutionMode
should the macro be executed.
Definition: MediaDescriptor.idl:530
string TemplateName
name of the template instead of the URL
Definition: MediaDescriptor.idl:465
boolean OpenNewView
opens a new view for an already loaded document
Definition: MediaDescriptor.idl:306
boolean LockContentExtraction
Setting this option will prevent copying/dragging any content anywhere.
Definition: MediaDescriptor.idl:566
com::sun::star::frame::XFrame Frame
specifies the frame containing the document.
Definition: MediaDescriptor.idl:558
Definition: Ambiguous.idl:20
boolean Unpacked
regulate using of compressing
Definition: MediaDescriptor.idl:484
sequence< ::com::sun::star::beans::NamedValue > EncryptionData
encryption information for encryption/decryption of documents
Definition: MediaDescriptor.idl:131
string HierarchicalDocumentName
The hierarchical path to the embedded document from topmost container.
Definition: MediaDescriptor.idl:199
short UpdateDocMode
can the document be updated depending from links.
Definition: MediaDescriptor.idl:538
string OpenFlags
please use the corresponding parameters of this descriptor instead
Definition: MediaDescriptor.idl:295
An interaction request handler.
Definition: XInteractionHandler.idl:26
boolean StartPresentation
start presentation from a document
Definition: MediaDescriptor.idl:394
string CharacterSet
identifier of used character set
Definition: MediaDescriptor.idl:79
string SuggestedSaveAsDir
allows to specify the URL that is used next time SaveAs dialog is opened
Definition: MediaDescriptor.idl:440
string FilterName
internal filter name
Definition: MediaDescriptor.idl:155
any FilterData
additional properties for filter
Definition: MediaDescriptor.idl:186
string Password
password for loading or storing documents
Definition: MediaDescriptor.idl:328
sequence< byte > PostData
contains the data for HTTP post method as a sequence of bytes.
Definition: MediaDescriptor.idl:338
describes properties of a document, regarding the relationship between the loaded document and the re...
Definition: MediaDescriptor.idl:44
boolean Preview
show preview
Definition: MediaDescriptor.idl:370
controls a status indicator which displays progress of longer actions to the user ...
Definition: XStatusIndicator.idl:32
com::sun::star::task::XStatusIndicator StatusIndicator
can be used for status information
Definition: MediaDescriptor.idl:431
string PostString
use MediaDescriptor::PostData instead of this
Definition: MediaDescriptor.idl:360
This is the basic interface to write data to a stream.
Definition: XOutputStream.idl:29
boolean RepairPackage
let the document be opened in repair mode
Definition: MediaDescriptor.idl:419
short Version
storage version
Definition: MediaDescriptor.idl:502
boolean LockEditDoc
Setting this option will disable switching to edit mode from read-only mode.
Definition: MediaDescriptor.idl:592
boolean Hidden
load document invisible
Definition: MediaDescriptor.idl:195
any ViewData
set special view state
Definition: MediaDescriptor.idl:512
boolean AsTemplate
document is a template
Definition: MediaDescriptor.idl:61
a frame object can be considered to be an "anchor" object where a component can be attached to...
Definition: XFrame.idl:38
string FilterFlags
same as MediaDescriptor::FilterOptions
Definition: MediaDescriptor.idl:165
boolean Aborted
May be set by filters or detection services if user has chosen to abort loading/saving, e.g.
Definition: MediaDescriptor.idl:49
boolean Replaceable
Mark the document as replaceable / a placeholder.
Definition: MediaDescriptor.idl:605
string Referer
name of document referrer
Definition: MediaDescriptor.idl:408
boolean PickListEntry
add loaded document to recent document list
Definition: MediaDescriptor.idl:349
string Author
the author of the document
Definition: MediaDescriptor.idl:70
string Comment
description of document
Definition: MediaDescriptor.idl:88
This is the basic interface to read data from a stream.
Definition: XInputStream.idl:29
string ViewControllerName
specifies the name of the view controller to create when loading a document
Definition: MediaDescriptor.idl:554
boolean LockExport
Setting this option will prevent exporting document content to any file.
Definition: MediaDescriptor.idl:574
string DocumentTitle
document title
Definition: MediaDescriptor.idl:115
string MediaType
specify mime type of content
Definition: MediaDescriptor.idl:257
string SuggestedSaveAsName
allows to specify the suggested file name that is used next time SaveAs dialog is opened ...
Definition: MediaDescriptor.idl:450
string FileName
same as MediaDescriptor::URL
Definition: MediaDescriptor.idl:141
string ExportDirectory
Directory to be used when saving (save as, save a copy) or exporting (to PDF, epub, ...).
Definition: MediaDescriptor.idl:455
string DocumentBaseURL
The base URL of the document to be used to resolve relative links.
Definition: MediaDescriptor.idl:107
short ViewId
id of the initial view
Definition: MediaDescriptor.idl:522
string JumpMark
jump to a marked position after loading
Definition: MediaDescriptor.idl:246
boolean ReadOnly
open document readonly
Definition: MediaDescriptor.idl:385
string URL
URL of the document.
Definition: MediaDescriptor.idl:492
com::sun::star::task::XInteractionHandler InteractionHandler
handle exceptional situations
Definition: MediaDescriptor.idl:237
boolean Overwrite
overwrite any existing file
Definition: MediaDescriptor.idl:316
com::sun::star::io::XInputStream InputStream
content of document
Definition: MediaDescriptor.idl:223
com::sun::star::io::XOutputStream OutputStream
a stream to receive the document data.
Definition: MediaDescriptor.idl:210