LibreOffice LibreOffice 26.2 SDK API Reference

Loading...
Searching...
No Matches
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
21module com { module sun { module star { module document {
22
44service MediaDescriptor
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
210 [optional,property] com::sun::star::io::XOutputStream OutputStream;
211
223 [optional,property] com::sun::star::io::XInputStream InputStream;
224
237 [optional,property] com::sun::star::task::XInteractionHandler InteractionHandler;
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
431 [optional,property] com::sun::star::task::XStatusIndicator StatusIndicator;
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
558 [optional,property] com::sun::star::frame::XFrame Frame;
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: */
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:39
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition XInputStream.idl:30
com::sun::star::io::XOutputStream
This is the basic interface to write data to a stream.
Definition XOutputStream.idl:30
com::sun::star::task::XInteractionHandler
An interaction request handler.
Definition XInteractionHandler.idl:27
com::sun::star::task::XStatusIndicator
controls a status indicator which displays progress of longer actions to the user
Definition XStatusIndicator.idl:33
com
Definition Ambiguous.idl:20
com::sun::star::document::MediaDescriptor
describes properties of a document, regarding the relationship between the loaded document and the re...
Definition MediaDescriptor.idl:45
com::sun::star::document::MediaDescriptor::Overwrite
boolean Overwrite
overwrite any existing file
Definition MediaDescriptor.idl:316
com::sun::star::document::MediaDescriptor::Author
string Author
the author of the document
Definition MediaDescriptor.idl:70
com::sun::star::document::MediaDescriptor::Hidden
boolean Hidden
load document invisible
Definition MediaDescriptor.idl:195
com::sun::star::document::MediaDescriptor::Unpacked
boolean Unpacked
regulate using of compressing
Definition MediaDescriptor.idl:484
com::sun::star::document::MediaDescriptor::PostString
string PostString
use MediaDescriptor::PostData instead of this
Definition MediaDescriptor.idl:360
com::sun::star::document::MediaDescriptor::MediaType
string MediaType
specify mime type of content
Definition MediaDescriptor.idl:257
com::sun::star::document::MediaDescriptor::ReadOnly
boolean ReadOnly
open document readonly
Definition MediaDescriptor.idl:385
com::sun::star::document::MediaDescriptor::StatusIndicator
com::sun::star::task::XStatusIndicator StatusIndicator
can be used for status information
Definition MediaDescriptor.idl:431
com::sun::star::document::MediaDescriptor::DocumentTitle
string DocumentTitle
document title
Definition MediaDescriptor.idl:115
com::sun::star::document::MediaDescriptor::Replaceable
boolean Replaceable
Mark the document as replaceable / a placeholder.
Definition MediaDescriptor.idl:605
com::sun::star::document::MediaDescriptor::LockSave
boolean LockSave
Setting this option will disable the save function.
Definition MediaDescriptor.idl:586
com::sun::star::document::MediaDescriptor::OpenNewView
boolean OpenNewView
opens a new view for an already loaded document
Definition MediaDescriptor.idl:306
com::sun::star::document::MediaDescriptor::PickListEntry
boolean PickListEntry
add loaded document to recent document list
Definition MediaDescriptor.idl:349
com::sun::star::document::MediaDescriptor::StartPresentation
boolean StartPresentation
start presentation from a document
Definition MediaDescriptor.idl:394
com::sun::star::document::MediaDescriptor::JumpMark
string JumpMark
jump to a marked position after loading
Definition MediaDescriptor.idl:246
com::sun::star::document::MediaDescriptor::FilterData
any FilterData
additional properties for filter
Definition MediaDescriptor.idl:186
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:450
com::sun::star::document::MediaDescriptor::Aborted
boolean Aborted
May be set by filters or detection services if user has chosen to abort loading/saving,...
Definition MediaDescriptor.idl:49
com::sun::star::document::MediaDescriptor::Referer
string Referer
name of document referrer
Definition MediaDescriptor.idl:408
com::sun::star::document::MediaDescriptor::CharacterSet
string CharacterSet
identifier of used character set
Definition MediaDescriptor.idl:79
com::sun::star::document::MediaDescriptor::FilterFlags
string FilterFlags
same as MediaDescriptor::FilterOptions
Definition MediaDescriptor.idl:165
com::sun::star::document::MediaDescriptor::Comment
string Comment
description of document
Definition MediaDescriptor.idl:88
com::sun::star::document::MediaDescriptor::Preview
boolean Preview
show preview
Definition MediaDescriptor.idl:370
com::sun::star::document::MediaDescriptor::LockPrint
boolean LockPrint
Setting this option will disable all print functions (including Printer setup).
Definition MediaDescriptor.idl:580
com::sun::star::document::MediaDescriptor::FilterName
string FilterName
internal filter name
Definition MediaDescriptor.idl:155
com::sun::star::document::MediaDescriptor::LockExport
boolean LockExport
Setting this option will prevent exporting document content to any file.
Definition MediaDescriptor.idl:574
com::sun::star::document::MediaDescriptor::TemplateName
string TemplateName
name of the template instead of the URL
Definition MediaDescriptor.idl:465
com::sun::star::document::MediaDescriptor::InputStream
com::sun::star::io::XInputStream InputStream
content of document
Definition MediaDescriptor.idl:223
com::sun::star::document::MediaDescriptor::OutputStream
com::sun::star::io::XOutputStream OutputStream
a stream to receive the document data.
Definition MediaDescriptor.idl:210
com::sun::star::document::MediaDescriptor::Frame
com::sun::star::frame::XFrame Frame
specifies the frame containing the document.
Definition MediaDescriptor.idl:558
com::sun::star::document::MediaDescriptor::DocumentBaseURL
string DocumentBaseURL
The base URL of the document to be used to resolve relative links.
Definition MediaDescriptor.idl:107
com::sun::star::document::MediaDescriptor::UpdateDocMode
short UpdateDocMode
can the document be updated depending from links.
Definition MediaDescriptor.idl:538
com::sun::star::document::MediaDescriptor::LockContentExtraction
boolean LockContentExtraction
Setting this option will prevent copying/dragging any content anywhere.
Definition MediaDescriptor.idl:566
com::sun::star::document::MediaDescriptor::HierarchicalDocumentName
string HierarchicalDocumentName
The hierarchical path to the embedded document from topmost container.
Definition MediaDescriptor.idl:199
com::sun::star::document::MediaDescriptor::Password
string Password
password for loading or storing documents
Definition MediaDescriptor.idl:328
com::sun::star::document::MediaDescriptor::PostData
sequence< byte > PostData
contains the data for HTTP post method as a sequence of bytes.
Definition MediaDescriptor.idl:338
com::sun::star::document::MediaDescriptor::EncryptionData
sequence< ::com::sun::star::beans::NamedValue > EncryptionData
encryption information for encryption/decryption of documents
Definition MediaDescriptor.idl:131
com::sun::star::document::MediaDescriptor::ComponentData
any ComponentData
pack specific properties of caller
Definition MediaDescriptor.idl:103
com::sun::star::document::MediaDescriptor::InteractionHandler
com::sun::star::task::XInteractionHandler InteractionHandler
handle exceptional situations
Definition MediaDescriptor.idl:237
com::sun::star::document::MediaDescriptor::RepairPackage
boolean RepairPackage
let the document be opened in repair mode
Definition MediaDescriptor.idl:419
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:440
com::sun::star::document::MediaDescriptor::Version
short Version
storage version
Definition MediaDescriptor.idl:502
com::sun::star::document::MediaDescriptor::FileName
string FileName
same as MediaDescriptor::URL
Definition MediaDescriptor.idl:141
com::sun::star::document::MediaDescriptor::ExportDirectory
string ExportDirectory
Directory to be used when saving (save as, save a copy) or exporting (to PDF, epub,...
Definition MediaDescriptor.idl:455
com::sun::star::document::MediaDescriptor::LockEditDoc
boolean LockEditDoc
Setting this option will disable switching to edit mode from read-only mode.
Definition MediaDescriptor.idl:592
com::sun::star::document::MediaDescriptor::AsTemplate
boolean AsTemplate
document is a template
Definition MediaDescriptor.idl:61
com::sun::star::document::MediaDescriptor::ViewId
short ViewId
id of the initial view
Definition MediaDescriptor.idl:522
com::sun::star::document::MediaDescriptor::ViewData
any ViewData
set special view state
Definition MediaDescriptor.idl:512
com::sun::star::document::MediaDescriptor::TemplateRegionName
string TemplateRegionName
name of the template instead of the URL
Definition MediaDescriptor.idl:474
com::sun::star::document::MediaDescriptor::ViewControllerName
string ViewControllerName
specifies the name of the view controller to create when loading a document
Definition MediaDescriptor.idl:554
com::sun::star::document::MediaDescriptor::URL
string URL
URL of the document.
Definition MediaDescriptor.idl:492
com::sun::star::document::MediaDescriptor::FilterOptions
string FilterOptions
additional properties for filter
Definition MediaDescriptor.idl:176
com::sun::star::document::MediaDescriptor::OpenFlags
string OpenFlags
please use the corresponding parameters of this descriptor instead
Definition MediaDescriptor.idl:295
com::sun::star::document::MediaDescriptor::MacroExecutionMode
short MacroExecutionMode
should the macro be executed.
Definition MediaDescriptor.idl:530