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

LibreOffice LibreOffice 7.3 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
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
32module com { module sun { module star { module document {
33
55service 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
166 [optional,property] string FilterName;
167
176 [optional,property] string FilterFlags;
177
187 [optional,property] string FilterOptions;
188
197 [optional,property] any FilterData;
198
206 [optional,property] boolean Hidden;
207
210 [optional,property] string HierarchicalDocumentName;
211
221 [optional,property] com::sun::star::io::XOutputStream OutputStream;
222
234 [optional,property] com::sun::star::io::XInputStream InputStream;
235
248 [optional,property] com::sun::star::task::XInteractionHandler InteractionHandler;
249
257 [optional,property] string JumpMark;
258
268 [optional,property] string MediaType;
269
306 [optional,property] string OpenFlags;
307
317 [optional,property] boolean OpenNewView;
318
319
327 [optional,property] boolean Overwrite;
328
339 [optional,property] string Password;
340
349 [optional,property] sequence< byte > PostData;
350
360 [optional,property] boolean PickListEntry;
361
371 [optional,property] string PostString;
372
381 [optional,property] boolean Preview;
382
396 [optional,property] boolean ReadOnly;
397
405 [optional,property] boolean StartPresentation;
406
419 [optional,property] string Referer;
420
430 [optional,property] boolean RepairPackage;
431
442 [optional,property] com::sun::star::task::XStatusIndicator StatusIndicator;
443
451 [optional,property] string SuggestedSaveAsDir;
452
461 [optional,property] string SuggestedSaveAsName;
462
471 [optional,property] string TemplateName;
472
480 [optional,property] string TemplateRegionName;
481
490 [optional,property] boolean Unpacked;
491
498 [optional,property] string URL;
499
508 [optional,property] short Version;
509
518 [optional,property] any ViewData;
519
528 [optional,property] short ViewId;
529
536 [optional,property] short MacroExecutionMode;
537
544 [optional,property] short UpdateDocMode;
545
560 [optional,property] string ViewControllerName;
561
564 [optional,property] com::sun::star::frame::XFrame Frame;
565
572 [optional,property] boolean LockContentExtraction;
573
580 [optional,property] boolean LockExport;
581
586 [optional,property] boolean LockPrint;
587
592 [optional,property] boolean LockSave;
593
598 [optional,property] boolean LockEditDoc;
599
611 [optional,property] boolean Replaceable;
612};
613
614
615}; }; }; };
616
617#endif
618
619/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
NamedValue.idl
Rectangle.idl
XFrame.idl
XInputStream.idl
XInteractionHandler.idl
XOutputStream.idl
XStatusIndicator.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:44
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition: XInputStream.idl:38
com::sun::star::io::XOutputStream
This is the basic interface to write data to a stream.
Definition: XOutputStream.idl:38
com::sun::star::task::XInteractionHandler
An interaction request handler.
Definition: XInteractionHandler.idl:33
com::sun::star::task::XStatusIndicator
controls a status indicator which displays progress of longer actions to the user
Definition: XStatusIndicator.idl:37
com
Definition: Ambiguous.idl:22
com::sun::star::document::MediaDescriptor
describes properties of a document, regarding the relationship between the loaded document and the re...
Definition: MediaDescriptor.idl:56
com::sun::star::document::MediaDescriptor::Overwrite
boolean Overwrite
overwrite any existing file
Definition: MediaDescriptor.idl:327
com::sun::star::document::MediaDescriptor::Author
string Author
the author of the document
Definition: MediaDescriptor.idl:81
com::sun::star::document::MediaDescriptor::Hidden
boolean Hidden
load document invisible
Definition: MediaDescriptor.idl:206
com::sun::star::document::MediaDescriptor::Unpacked
boolean Unpacked
regulate using of compressing
Definition: MediaDescriptor.idl:490
com::sun::star::document::MediaDescriptor::PostString
string PostString
use MediaDescriptor::PostData instead of this
Definition: MediaDescriptor.idl:371
com::sun::star::document::MediaDescriptor::MediaType
string MediaType
specify mime type of content
Definition: MediaDescriptor.idl:268
com::sun::star::document::MediaDescriptor::ReadOnly
boolean ReadOnly
open document readonly
Definition: MediaDescriptor.idl:396
com::sun::star::document::MediaDescriptor::StatusIndicator
com::sun::star::task::XStatusIndicator StatusIndicator
can be used for status information
Definition: MediaDescriptor.idl:442
com::sun::star::document::MediaDescriptor::DocumentTitle
string DocumentTitle
document title
Definition: MediaDescriptor.idl:126
com::sun::star::document::MediaDescriptor::Replaceable
boolean Replaceable
Mark the document as replaceable / a placeholder.
Definition: MediaDescriptor.idl:611
com::sun::star::document::MediaDescriptor::LockSave
boolean LockSave
Setting this option will disable the save function.
Definition: MediaDescriptor.idl:592
com::sun::star::document::MediaDescriptor::OpenNewView
boolean OpenNewView
opens a new view for an already loaded document
Definition: MediaDescriptor.idl:317
com::sun::star::document::MediaDescriptor::PickListEntry
boolean PickListEntry
add loaded document to recent document list
Definition: MediaDescriptor.idl:360
com::sun::star::document::MediaDescriptor::StartPresentation
boolean StartPresentation
start presentation from a document
Definition: MediaDescriptor.idl:405
com::sun::star::document::MediaDescriptor::JumpMark
string JumpMark
jump to a marked position after loading
Definition: MediaDescriptor.idl:257
com::sun::star::document::MediaDescriptor::FilterData
any FilterData
additional properties for filter
Definition: MediaDescriptor.idl:197
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:461
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:60
com::sun::star::document::MediaDescriptor::Referer
string Referer
name of document referrer
Definition: MediaDescriptor.idl:419
com::sun::star::document::MediaDescriptor::CharacterSet
string CharacterSet
identifier of used character set
Definition: MediaDescriptor.idl:90
com::sun::star::document::MediaDescriptor::FilterFlags
string FilterFlags
same as MediaDescriptor::FilterOptions
Definition: MediaDescriptor.idl:176
com::sun::star::document::MediaDescriptor::Comment
string Comment
description of document
Definition: MediaDescriptor.idl:99
com::sun::star::document::MediaDescriptor::Preview
boolean Preview
show preview
Definition: MediaDescriptor.idl:381
com::sun::star::document::MediaDescriptor::LockPrint
boolean LockPrint
Setting this option will disable all print functions (including Printer setup)
Definition: MediaDescriptor.idl:586
com::sun::star::document::MediaDescriptor::FilterName
string FilterName
internal filter name
Definition: MediaDescriptor.idl:166
com::sun::star::document::MediaDescriptor::LockExport
boolean LockExport
Setting this option will prevent exporting document content to any file.
Definition: MediaDescriptor.idl:580
com::sun::star::document::MediaDescriptor::TemplateName
string TemplateName
name of the template instead of the URL
Definition: MediaDescriptor.idl:471
com::sun::star::document::MediaDescriptor::InputStream
com::sun::star::io::XInputStream InputStream
content of document
Definition: MediaDescriptor.idl:234
com::sun::star::document::MediaDescriptor::OutputStream
com::sun::star::io::XOutputStream OutputStream
a stream to receive the document data.
Definition: MediaDescriptor.idl:221
com::sun::star::document::MediaDescriptor::Frame
com::sun::star::frame::XFrame Frame
specifies the frame containing the document.
Definition: MediaDescriptor.idl:564
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
com::sun::star::document::MediaDescriptor::UpdateDocMode
short UpdateDocMode
can the document be updated depending from links.
Definition: MediaDescriptor.idl:544
com::sun::star::document::MediaDescriptor::LockContentExtraction
boolean LockContentExtraction
Setting this option will prevent copying/dragging any content anywhere.
Definition: MediaDescriptor.idl:572
com::sun::star::document::MediaDescriptor::HierarchicalDocumentName
string HierarchicalDocumentName
The hierarchical path to the embedded document from topmost container.
Definition: MediaDescriptor.idl:210
com::sun::star::document::MediaDescriptor::Password
string Password
password for loading or storing documents
Definition: MediaDescriptor.idl:339
com::sun::star::document::MediaDescriptor::PostData
sequence< byte > PostData
contains the data for HTTP post method as a sequence of bytes.
Definition: MediaDescriptor.idl:349
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::ComponentData
any ComponentData
pack specific properties of caller
Definition: MediaDescriptor.idl:114
com::sun::star::document::MediaDescriptor::InteractionHandler
com::sun::star::task::XInteractionHandler InteractionHandler
handle exceptional situations
Definition: MediaDescriptor.idl:248
com::sun::star::document::MediaDescriptor::RepairPackage
boolean RepairPackage
let the document be opened in repair mode
Definition: MediaDescriptor.idl:430
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:451
com::sun::star::document::MediaDescriptor::Version
short Version
storage version
Definition: MediaDescriptor.idl:508
com::sun::star::document::MediaDescriptor::FileName
string FileName
same as MediaDescriptor::URL
Definition: MediaDescriptor.idl:152
com::sun::star::document::MediaDescriptor::LockEditDoc
boolean LockEditDoc
Setting this option will disable switching to edit mode from read-only mode.
Definition: MediaDescriptor.idl:598
com::sun::star::document::MediaDescriptor::AsTemplate
boolean AsTemplate
document is a template
Definition: MediaDescriptor.idl:72
com::sun::star::document::MediaDescriptor::ViewId
short ViewId
id of the initial view
Definition: MediaDescriptor.idl:528
com::sun::star::document::MediaDescriptor::ViewData
any ViewData
set special view state
Definition: MediaDescriptor.idl:518
com::sun::star::document::MediaDescriptor::TemplateRegionName
string TemplateRegionName
name of the template instead of the URL
Definition: MediaDescriptor.idl:480
com::sun::star::document::MediaDescriptor::ViewControllerName
string ViewControllerName
specifies the name of the view controller to create when loading a document
Definition: MediaDescriptor.idl:560
com::sun::star::document::MediaDescriptor::URL
string URL
URL of the document.
Definition: MediaDescriptor.idl:498
com::sun::star::document::MediaDescriptor::FilterOptions
string FilterOptions
additional properties for filter
Definition: MediaDescriptor.idl:187
com::sun::star::document::MediaDescriptor::OpenFlags
string OpenFlags
please use the corresponding parameters of this descriptor instead
Definition: MediaDescriptor.idl:306
com::sun::star::document::MediaDescriptor::MacroExecutionMode
short MacroExecutionMode
should the macro be executed.
Definition: MediaDescriptor.idl:536
URL.idl