1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_document_MediaDescriptor_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_document_MediaDescriptor_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_io_XOutputStream_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/io/XOutputStream.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir#ifndef __com_sun_star_io_XInputStream_idl__ 35*cdf0e10cSrcweir#include <com/sun/star/io/XInputStream.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir#ifndef __com_sun_star_awt_Rectangle_idl__ 39*cdf0e10cSrcweir#include <com/sun/star/awt/Rectangle.idl> 40*cdf0e10cSrcweir#endif 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir#ifndef __com_sun_star_beans_NamedValue_idl__ 43*cdf0e10cSrcweir#include <com/sun/star/beans/NamedValue.idl> 44*cdf0e10cSrcweir#endif 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir#ifndef __com_sun_star_util_URL_idl__ 47*cdf0e10cSrcweir#include <com/sun/star/util/URL.idl> 48*cdf0e10cSrcweir#endif 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir#ifndef __com_sun_star_task_XInteractionHandler_idl__ 51*cdf0e10cSrcweir#include <com/sun/star/task/XInteractionHandler.idl> 52*cdf0e10cSrcweir#endif 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir#ifndef __com_sun_star_task_XStatusIndicator_idl__ 55*cdf0e10cSrcweir#include <com/sun/star/task/XStatusIndicator.idl> 56*cdf0e10cSrcweir#endif 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir#ifndef __com_sun_star_frame_XFrame_idl__ 59*cdf0e10cSrcweir#include <com/sun/star/frame/XFrame.idl> 60*cdf0e10cSrcweir#endif 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir//============================================================================= 63*cdf0e10cSrcweir 64*cdf0e10cSrcweirmodule com { module sun { module star { module document { 65*cdf0e10cSrcweir 66*cdf0e10cSrcweir//============================================================================= 67*cdf0e10cSrcweir/** describes properties of a document, regarding the relationship 68*cdf0e10cSrcweir between the loaded document and the resource the document is 69*cdf0e10cSrcweir loaded from / stored to. 70*cdf0e10cSrcweir 71*cdf0e10cSrcweir <p> 72*cdf0e10cSrcweir This service may be represented by a 73*cdf0e10cSrcweir <type scope="com::sun::star::beans" dim="[]">PropertyValue</type>. 74*cdf0e10cSrcweir Such descriptors will be passed to different functions, included into possible 75*cdf0e10cSrcweir load/save proccesses. Every member of such process can use this descriptor 76*cdf0e10cSrcweir and may change it if to actualize the informations about the document. 77*cdf0e10cSrcweir So this descriptor should be used as an in/out parameter. 78*cdf0e10cSrcweir </p> 79*cdf0e10cSrcweir 80*cdf0e10cSrcweir <p> 81*cdf0e10cSrcweir Note:<br> 82*cdf0e10cSrcweir It's not allowed to hold member of this descriptor by references longer the they 83*cdf0e10cSrcweir will be used (especialy a possible stream). It's allowed to use it directly 84*cdf0e10cSrcweir or by copying it only. 85*cdf0e10cSrcweir </p> 86*cdf0e10cSrcweir 87*cdf0e10cSrcweir @see com::sun::star::beans::PropertyValue 88*cdf0e10cSrcweir */ 89*cdf0e10cSrcweirpublished service MediaDescriptor 90*cdf0e10cSrcweir{ 91*cdf0e10cSrcweir //------------------------------------------------------------------------- 92*cdf0e10cSrcweir /** May be set by filters or detection services if user has choosen to 93*cdf0e10cSrcweir abort loading/saving, e.g. while entering a password. 94*cdf0e10cSrcweir */ 95*cdf0e10cSrcweir [optional,property] boolean Aborted; 96*cdf0e10cSrcweir 97*cdf0e10cSrcweir //------------------------------------------------------------------------- 98*cdf0e10cSrcweir /** document is a template 99*cdf0e10cSrcweir 100*cdf0e10cSrcweir <p> 101*cdf0e10cSrcweir Loading a component of type "template" creates a new untitled document 102*cdf0e10cSrcweir by default, but setting the "AsTemplate" property to <FALSE/> loads the 103*cdf0e10cSrcweir template document for editing. Setting "AsTemplate" to <TRUE/> creates a 104*cdf0e10cSrcweir new untitled document out of the loaded document, even if it has not 105*cdf0e10cSrcweir a "template" type. 106*cdf0e10cSrcweir </p> 107*cdf0e10cSrcweir */ 108*cdf0e10cSrcweir [optional,property] boolean AsTemplate; 109*cdf0e10cSrcweir 110*cdf0e10cSrcweir //------------------------------------------------------------------------- 111*cdf0e10cSrcweir /** the author of the document 112*cdf0e10cSrcweir 113*cdf0e10cSrcweir <p> 114*cdf0e10cSrcweir Only for storing versions in components supporting versioning: 115*cdf0e10cSrcweir author of version. 116*cdf0e10cSrcweir </p> 117*cdf0e10cSrcweir */ 118*cdf0e10cSrcweir [optional,property] string Author; 119*cdf0e10cSrcweir 120*cdf0e10cSrcweir //------------------------------------------------------------------------- 121*cdf0e10cSrcweir /** identifier of used character set 122*cdf0e10cSrcweir 123*cdf0e10cSrcweir <p> 124*cdf0e10cSrcweir Defines the character set for document formats that contain single 125*cdf0e10cSrcweir byte characters (if necessary). 126*cdf0e10cSrcweir </p> 127*cdf0e10cSrcweir */ 128*cdf0e10cSrcweir [optional,property] string CharacterSet; 129*cdf0e10cSrcweir 130*cdf0e10cSrcweir //------------------------------------------------------------------------- 131*cdf0e10cSrcweir /** description of document 132*cdf0e10cSrcweir 133*cdf0e10cSrcweir <p> 134*cdf0e10cSrcweir Only for storing versions in components supporting versioning: 135*cdf0e10cSrcweir comment (description) for stored version. 136*cdf0e10cSrcweir </p> 137*cdf0e10cSrcweir */ 138*cdf0e10cSrcweir [optional,property] string Comment; 139*cdf0e10cSrcweir 140*cdf0e10cSrcweir //------------------------------------------------------------------------- 141*cdf0e10cSrcweir /** pack specific properties of caller 142*cdf0e10cSrcweir 143*cdf0e10cSrcweir <p> 144*cdf0e10cSrcweir This is a parameter that can be used for any properties specific 145*cdf0e10cSrcweir for a special component type. Format of that depends from real 146*cdf0e10cSrcweir type of adressed component. 147*cdf0e10cSrcweir </p> 148*cdf0e10cSrcweir 149*cdf0e10cSrcweir <p> 150*cdf0e10cSrcweir For extensibility, it is recommended to use values of type 151*cdf0e10cSrcweir sequence<com.sun.star.beans.NamedValue> with this property. 152*cdf0e10cSrcweir </p> 153*cdf0e10cSrcweir */ 154*cdf0e10cSrcweir [optional,property] any ComponentData; 155*cdf0e10cSrcweir 156*cdf0e10cSrcweir //------------------------------------------------------------------------- 157*cdf0e10cSrcweir /** The base URL of the document to be used to resolve relative links. 158*cdf0e10cSrcweir */ 159*cdf0e10cSrcweir [optional,property] string DocumentBaseURL; 160*cdf0e10cSrcweir 161*cdf0e10cSrcweir //------------------------------------------------------------------------- 162*cdf0e10cSrcweir /** document title 163*cdf0e10cSrcweir 164*cdf0e10cSrcweir <p> 165*cdf0e10cSrcweir This parameter can be used to specify a title for a document. 166*cdf0e10cSrcweir </p> 167*cdf0e10cSrcweir */ 168*cdf0e10cSrcweir [optional,property] string DocumentTitle; 169*cdf0e10cSrcweir 170*cdf0e10cSrcweir //------------------------------------------------------------------------- 171*cdf0e10cSrcweir /** encryption information for encryption/decryption of documents 172*cdf0e10cSrcweir 173*cdf0e10cSrcweir <p> 174*cdf0e10cSrcweir It contains the necessary information for encryption/decryption of 175*cdf0e10cSrcweir a component (if necessary). 176*cdf0e10cSrcweir If neither password nor encryption data is specified, loading of 177*cdf0e10cSrcweir a password protected document will fail, storing will be done without 178*cdf0e10cSrcweir encryption. If both are provided, the encryption data is used 179*cdf0e10cSrcweir ( if the filter supports it ). 180*cdf0e10cSrcweir </p> 181*cdf0e10cSrcweir <p> 182*cdf0e10cSrcweir The encryption data is generated based on the password. 183*cdf0e10cSrcweir </p> 184*cdf0e10cSrcweir */ 185*cdf0e10cSrcweir [optional,property] sequence< ::com::sun::star::beans::NamedValue > EncryptionData; 186*cdf0e10cSrcweir 187*cdf0e10cSrcweir //------------------------------------------------------------------------- 188*cdf0e10cSrcweir /** same as <member>MediaDescriptor::URL</member> 189*cdf0e10cSrcweir 190*cdf0e10cSrcweir <p> 191*cdf0e10cSrcweir It will be supported for compatibility reasons only. 192*cdf0e10cSrcweir </p> 193*cdf0e10cSrcweir 194*cdf0e10cSrcweir @deprecated 195*cdf0e10cSrcweir */ 196*cdf0e10cSrcweir [optional,property] string FileName; 197*cdf0e10cSrcweir 198*cdf0e10cSrcweir //------------------------------------------------------------------------- 199*cdf0e10cSrcweir /** internal filter name 200*cdf0e10cSrcweir 201*cdf0e10cSrcweir <p> 202*cdf0e10cSrcweir Name of a filter that should be used for loading or storing the component. 203*cdf0e10cSrcweir Names must match the names of the <type>TypeDetection</type> configuration, 204*cdf0e10cSrcweir invalid names are ignored. If a name is specified on loading, 205*cdf0e10cSrcweir it still will be verified by a filter detection, but in case of doubt 206*cdf0e10cSrcweir it will be preferred. 207*cdf0e10cSrcweir </p> 208*cdf0e10cSrcweir */ 209*cdf0e10cSrcweir [optional,property] string FilterName; 210*cdf0e10cSrcweir 211*cdf0e10cSrcweir //------------------------------------------------------------------------- 212*cdf0e10cSrcweir /** same as <member>MediaDescriptor::FilterOptions</member> 213*cdf0e10cSrcweir 214*cdf0e10cSrcweir <p> 215*cdf0e10cSrcweir It will be supported for compatibility reasons only. 216*cdf0e10cSrcweir </p> 217*cdf0e10cSrcweir 218*cdf0e10cSrcweir @deprecated 219*cdf0e10cSrcweir */ 220*cdf0e10cSrcweir [optional,property] string FilterFlags; 221*cdf0e10cSrcweir 222*cdf0e10cSrcweir //------------------------------------------------------------------------- 223*cdf0e10cSrcweir /** additional properties for filter 224*cdf0e10cSrcweir 225*cdf0e10cSrcweir <p> 226*cdf0e10cSrcweir Some filters need additional parameters; use only together with property 227*cdf0e10cSrcweir <member>MediaDescriptor::FilterName</member>. Details must be documented 228*cdf0e10cSrcweir by the filter. This is an old format for some filters. If a string is not 229*cdf0e10cSrcweir enough, filters can use the property <member>MediaDescriptor::FilterData</member>. 230*cdf0e10cSrcweir </p> 231*cdf0e10cSrcweir */ 232*cdf0e10cSrcweir [optional,property] string FilterOptions; 233*cdf0e10cSrcweir 234*cdf0e10cSrcweir //------------------------------------------------------------------------- 235*cdf0e10cSrcweir /** additional properties for filter 236*cdf0e10cSrcweir 237*cdf0e10cSrcweir <p> 238*cdf0e10cSrcweir This is a parameter that can be used for any properties specific 239*cdf0e10cSrcweir for a special filter type. It should be used if 240*cdf0e10cSrcweir <member>MediaDescriptor::FilterOptions</member> isn't enough. 241*cdf0e10cSrcweir </p> 242*cdf0e10cSrcweir */ 243*cdf0e10cSrcweir [optional,property] any FilterData; 244*cdf0e10cSrcweir 245*cdf0e10cSrcweir //------------------------------------------------------------------------- 246*cdf0e10cSrcweir /** load document invisible 247*cdf0e10cSrcweir 248*cdf0e10cSrcweir <p> 249*cdf0e10cSrcweir Defines if the loaded component is made visible. If this property is not 250*cdf0e10cSrcweir specified, the component is made visible by default. 251*cdf0e10cSrcweir </p> 252*cdf0e10cSrcweir */ 253*cdf0e10cSrcweir [optional,property] boolean Hidden; 254*cdf0e10cSrcweir 255*cdf0e10cSrcweir //------------------------------------------------------------------------- 256*cdf0e10cSrcweir /** The hierarchical path to the embedded document from topmost container. 257*cdf0e10cSrcweir */ 258*cdf0e10cSrcweir [optional,property] string HierarchicalDocumentName; 259*cdf0e10cSrcweir 260*cdf0e10cSrcweir //------------------------------------------------------------------------- 261*cdf0e10cSrcweir /** a stream to receive the document data. 262*cdf0e10cSrcweir 263*cdf0e10cSrcweir <p> 264*cdf0e10cSrcweir If used when storing a document: writing must be done using this stream. 265*cdf0e10cSrcweir If no stream is provided, the loader will create a stream by itself using 266*cdf0e10cSrcweir the other properties. It is not allowed to keep a reference to this 267*cdf0e10cSrcweir OutputStream after storing the component. 268*cdf0e10cSrcweir </p> 269*cdf0e10cSrcweir */ 270*cdf0e10cSrcweir [optional,property] com::sun::star::io::XOutputStream OutputStream; 271*cdf0e10cSrcweir 272*cdf0e10cSrcweir //------------------------------------------------------------------------- 273*cdf0e10cSrcweir /** content of document 274*cdf0e10cSrcweir 275*cdf0e10cSrcweir <p> 276*cdf0e10cSrcweir If used when loading a document: reading must be done using this stream. 277*cdf0e10cSrcweir If no stream is provided, the loader will create a stream by itself using 278*cdf0e10cSrcweir the other properties. It is not allowed to keep a reference to this 279*cdf0e10cSrcweir InputStream after loading the component, and it would be useless, because 280*cdf0e10cSrcweir in general an InputStream is usable for readong only once, except when it 281*cdf0e10cSrcweir also implements the <type scope="com::sun::star::io">XSeekable</type> interface. 282*cdf0e10cSrcweir </p> 283*cdf0e10cSrcweir */ 284*cdf0e10cSrcweir [optional,property] com::sun::star::io::XInputStream InputStream; 285*cdf0e10cSrcweir 286*cdf0e10cSrcweir //------------------------------------------------------------------------- 287*cdf0e10cSrcweir /** handle exceptional situations 288*cdf0e10cSrcweir 289*cdf0e10cSrcweir <p> 290*cdf0e10cSrcweir Object implementing the <type scope="com::sun::star::task">InteractionHandler</type> 291*cdf0e10cSrcweir service that is used to handle exceptional situations where proceeding with the task 292*cdf0e10cSrcweir is impossible without additional information or impossible at all. 293*cdf0e10cSrcweir The implemented api provides a default implementation for it that can handle many situations. 294*cdf0e10cSrcweir If no InteractionHandler is set, a suitable exception is thrown. 295*cdf0e10cSrcweir It is not allowed to keep a reference to this object, even not in the loaded 296*cdf0e10cSrcweir or stored components' copy of the MediaDescriptor provided by its arguments attribute. 297*cdf0e10cSrcweir </p> 298*cdf0e10cSrcweir */ 299*cdf0e10cSrcweir [optional,property] com::sun::star::task::XInteractionHandler InteractionHandler; 300*cdf0e10cSrcweir 301*cdf0e10cSrcweir //------------------------------------------------------------------------- 302*cdf0e10cSrcweir /** jump to a marked position after loading 303*cdf0e10cSrcweir 304*cdf0e10cSrcweir <p> 305*cdf0e10cSrcweir This is the same as the text behind a '#' in a http URL. But 306*cdf0e10cSrcweir this syntax with a '#' is not specified in most URL schemas. 307*cdf0e10cSrcweir </p> 308*cdf0e10cSrcweir */ 309*cdf0e10cSrcweir [optional,property] string JumpMark; 310*cdf0e10cSrcweir 311*cdf0e10cSrcweir //------------------------------------------------------------------------- 312*cdf0e10cSrcweir /** specify mime type of content 313*cdf0e10cSrcweir 314*cdf0e10cSrcweir <p> 315*cdf0e10cSrcweir Type of the medium to load, that must match to one of the types defined 316*cdf0e10cSrcweir in the <type>TypeDetection</type> configuration (otherwise it's ignored). 317*cdf0e10cSrcweir This bypasses the type detection of the <type scope="com::sun::star::frame">Desktop</type> environment, 318*cdf0e10cSrcweir so passing a wrong MediaType will cause failure of loading. 319*cdf0e10cSrcweir </p> 320*cdf0e10cSrcweir */ 321*cdf0e10cSrcweir [optional,property] string MediaType; 322*cdf0e10cSrcweir 323*cdf0e10cSrcweir //------------------------------------------------------------------------- 324*cdf0e10cSrcweir /** please use the corresponding parameters of this descriptor instead 325*cdf0e10cSrcweir 326*cdf0e10cSrcweir <p> 327*cdf0e10cSrcweir String that summarizes some flags for loading. The string contains capital 328*cdf0e10cSrcweir letters for the flags:<br> 329*cdf0e10cSrcweir <table border=1> 330*cdf0e10cSrcweir <tr> 331*cdf0e10cSrcweir <td><strong>flag</strong></td> 332*cdf0e10cSrcweir <td><strong>value</strong></td> 333*cdf0e10cSrcweir <td><strong>replacement</strong></td> 334*cdf0e10cSrcweir </tr> 335*cdf0e10cSrcweir <tr> 336*cdf0e10cSrcweir <td><em>ReadOnly</em></td> 337*cdf0e10cSrcweir <td>R</td> 338*cdf0e10cSrcweir <td><member>MediaDescriptor::ReadOnly</member></td> 339*cdf0e10cSrcweir </tr> 340*cdf0e10cSrcweir <tr> 341*cdf0e10cSrcweir <td><em>Preview</em></td> 342*cdf0e10cSrcweir <td>B</td> 343*cdf0e10cSrcweir <td><member>MediaDescriptor::Preview</member></td> 344*cdf0e10cSrcweir </tr> 345*cdf0e10cSrcweir <tr> 346*cdf0e10cSrcweir <td><em>AsTemplate</em></td> 347*cdf0e10cSrcweir <td>T</td> 348*cdf0e10cSrcweir <td><member>MediaDescriptor::AsTemplate</member></td> 349*cdf0e10cSrcweir </tr> 350*cdf0e10cSrcweir <tr> 351*cdf0e10cSrcweir <td><em>Hidden</em></td> 352*cdf0e10cSrcweir <td>H</td> 353*cdf0e10cSrcweir <td><member>MediaDescriptor::Hidden</member></td> 354*cdf0e10cSrcweir </tr> 355*cdf0e10cSrcweir </table> 356*cdf0e10cSrcweir </p> 357*cdf0e10cSrcweir 358*cdf0e10cSrcweir @deprecated 359*cdf0e10cSrcweir */ 360*cdf0e10cSrcweir [optional,property] string OpenFlags; 361*cdf0e10cSrcweir 362*cdf0e10cSrcweir //------------------------------------------------------------------------- 363*cdf0e10cSrcweir /** opens a new view for an already loaded document 364*cdf0e10cSrcweir 365*cdf0e10cSrcweir <p> 366*cdf0e10cSrcweir Setting this to <TRUE/> forces the component to create a new window on loading 367*cdf0e10cSrcweir in any case. If the component supports multiple views, a second view is 368*cdf0e10cSrcweir opened, if not, the component is loaded one more time. Otherwise the behavior 369*cdf0e10cSrcweir depends on the default window handling of the <type scope="com::sun::star::frame">Desktop</type> environment. 370*cdf0e10cSrcweir </p> 371*cdf0e10cSrcweir */ 372*cdf0e10cSrcweir [optional,property] boolean OpenNewView; 373*cdf0e10cSrcweir 374*cdf0e10cSrcweir 375*cdf0e10cSrcweir //------------------------------------------------------------------------- 376*cdf0e10cSrcweir /** overwrite any existing file 377*cdf0e10cSrcweir 378*cdf0e10cSrcweir <p> 379*cdf0e10cSrcweir For storing only: overwrite any existing file, default is <FALSE/>, 380*cdf0e10cSrcweir so an error occurs if the target file already exists. 381*cdf0e10cSrcweir </p> 382*cdf0e10cSrcweir */ 383*cdf0e10cSrcweir [optional,property] boolean Overwrite; 384*cdf0e10cSrcweir 385*cdf0e10cSrcweir //------------------------------------------------------------------------- 386*cdf0e10cSrcweir /** pasword for loading storing documents 387*cdf0e10cSrcweir 388*cdf0e10cSrcweir <p> 389*cdf0e10cSrcweir It contains a password for loading or storing a component (if necessary). 390*cdf0e10cSrcweir If neither password nor encryption data is specified, loading of 391*cdf0e10cSrcweir a password protected document will fail, storing will be done without 392*cdf0e10cSrcweir encryption. If both are provided, the encryption data is used 393*cdf0e10cSrcweir ( if the filter supports it ). 394*cdf0e10cSrcweir </p> 395*cdf0e10cSrcweir */ 396*cdf0e10cSrcweir [optional,property] string Password; 397*cdf0e10cSrcweir 398*cdf0e10cSrcweir //------------------------------------------------------------------------- 399*cdf0e10cSrcweir /** contains the data for HTTP post method as a sequence of bytes. 400*cdf0e10cSrcweir 401*cdf0e10cSrcweir <p> 402*cdf0e10cSrcweir Data to send to a location described by the media descriptor to get 403*cdf0e10cSrcweir a result in return that will be loaded as a component 404*cdf0e10cSrcweir (usually in webforms). Default is: no PostData. 405*cdf0e10cSrcweir </p> 406*cdf0e10cSrcweir */ 407*cdf0e10cSrcweir [optional,property] sequence< byte > PostData; 408*cdf0e10cSrcweir 409*cdf0e10cSrcweir //------------------------------------------------------------------------- 410*cdf0e10cSrcweir /** use <member>MediaDescriptor::PostData</member> instead of this 411*cdf0e10cSrcweir 412*cdf0e10cSrcweir <p> 413*cdf0e10cSrcweir Same as PostData, but the data is transferred as a string 414*cdf0e10cSrcweir (just for compatibility). 415*cdf0e10cSrcweir </p> 416*cdf0e10cSrcweir 417*cdf0e10cSrcweir @deprecated 418*cdf0e10cSrcweir */ 419*cdf0e10cSrcweir [optional,property] string PostString; 420*cdf0e10cSrcweir 421*cdf0e10cSrcweir //------------------------------------------------------------------------- 422*cdf0e10cSrcweir /** show preview 423*cdf0e10cSrcweir 424*cdf0e10cSrcweir <p> 425*cdf0e10cSrcweir Setting this to <TRUE/> tells the a loaded component that it is loaded as 426*cdf0e10cSrcweir a preview, so it can optimize loading and viewing for this special purpose. 427*cdf0e10cSrcweir Default is <FALSE/>. 428*cdf0e10cSrcweir </p> 429*cdf0e10cSrcweir */ 430*cdf0e10cSrcweir [optional,property] boolean Preview; 431*cdf0e10cSrcweir 432*cdf0e10cSrcweir //------------------------------------------------------------------------- 433*cdf0e10cSrcweir /** open document readonly 434*cdf0e10cSrcweir 435*cdf0e10cSrcweir <p> 436*cdf0e10cSrcweir Tells whether a document should be loaded in a (logical) readonly or in 437*cdf0e10cSrcweir read/write mode. If opening in the desired mode is impossible, an error occurs. 438*cdf0e10cSrcweir By default the loaded content decides what to do: if its UCB content supports 439*cdf0e10cSrcweir a "readonly" property, the logical open mode depends on that, otherwise 440*cdf0e10cSrcweir it will be read/write. This is only a UI related property, opening a 441*cdf0e10cSrcweir document in read only mode will not prevent the component from being 442*cdf0e10cSrcweir modified by API calls, but all modifying functionality in the UI will 443*cdf0e10cSrcweir be disabled or removed. 444*cdf0e10cSrcweir </p> 445*cdf0e10cSrcweir */ 446*cdf0e10cSrcweir [optional,property] boolean ReadOnly; 447*cdf0e10cSrcweir 448*cdf0e10cSrcweir //------------------------------------------------------------------------- 449*cdf0e10cSrcweir /** start presentation from a document 450*cdf0e10cSrcweir 451*cdf0e10cSrcweir <p> 452*cdf0e10cSrcweir Tells the component loading the document that a presentation that is in the 453*cdf0e10cSrcweir document is to be started right away. 454*cdf0e10cSrcweir </p> 455*cdf0e10cSrcweir */ 456*cdf0e10cSrcweir [optional,property] boolean StartPresentation; 457*cdf0e10cSrcweir 458*cdf0e10cSrcweir //------------------------------------------------------------------------- 459*cdf0e10cSrcweir /** name of document referrer 460*cdf0e10cSrcweir 461*cdf0e10cSrcweir <p> 462*cdf0e10cSrcweir A URL describing the environment of the request; f.e. a referrer may be a 463*cdf0e10cSrcweir URL of a document, if a hyperlink inside this document is clicked to load 464*cdf0e10cSrcweir another document. The referrer may be evaluated by the addressed UCB content 465*cdf0e10cSrcweir or the loaded document. Without a referrer the processing of URLs that 466*cdf0e10cSrcweir needs security checks will be denied, f.e. "macro:" URLs. 467*cdf0e10cSrcweir <br> 468*cdf0e10cSrcweir Don't be confused about the wrong spelling; is kept for compatibility reasons. 469*cdf0e10cSrcweir </p> 470*cdf0e10cSrcweir */ 471*cdf0e10cSrcweir [optional,property] string Referer; 472*cdf0e10cSrcweir 473*cdf0e10cSrcweir //------------------------------------------------------------------------- 474*cdf0e10cSrcweir /** let the document be opened in repair mode 475*cdf0e10cSrcweir 476*cdf0e10cSrcweir <p> 477*cdf0e10cSrcweir For loading of corrupted zip packages: Setting this to <TRUE/> let the document 478*cdf0e10cSrcweir be opened in repair mode, so as much as possible information will be retrieved. 479*cdf0e10cSrcweir </p> 480*cdf0e10cSrcweir 481*cdf0e10cSrcweir @since OOo 1.1.2 482*cdf0e10cSrcweir */ 483*cdf0e10cSrcweir [optional,property] boolean RepairPackage; 484*cdf0e10cSrcweir 485*cdf0e10cSrcweir //------------------------------------------------------------------------- 486*cdf0e10cSrcweir /** can be used for status informations 487*cdf0e10cSrcweir 488*cdf0e10cSrcweir <p> 489*cdf0e10cSrcweir Object implementing the <type scope="com::sun::star::task">XStatusIndicator</type> 490*cdf0e10cSrcweir interface that can be used to give status information (text or progress) for the task. 491*cdf0e10cSrcweir The office provides a default implementation for it. It is not allowed to keep 492*cdf0e10cSrcweir a reference to this object, even not in the loaded or stored components' 493*cdf0e10cSrcweir copy of the MediaDescriptor provided by its arguments attribute. 494*cdf0e10cSrcweir </p> 495*cdf0e10cSrcweir */ 496*cdf0e10cSrcweir [optional,property] com::sun::star::task::XStatusIndicator StatusIndicator; 497*cdf0e10cSrcweir 498*cdf0e10cSrcweir //------------------------------------------------------------------------- 499*cdf0e10cSrcweir /** allows to specify the URL that is used next time SaveAs dialog is opened 500*cdf0e10cSrcweir 501*cdf0e10cSrcweir <p> 502*cdf0e10cSrcweir If the parameter is specified, the URL will be used by SaveAs dialog 503*cdf0e10cSrcweir next time as target folder. 504*cdf0e10cSrcweir </p> 505*cdf0e10cSrcweir */ 506*cdf0e10cSrcweir [optional,property] string SuggestedSaveAsDir; 507*cdf0e10cSrcweir 508*cdf0e10cSrcweir //------------------------------------------------------------------------- 509*cdf0e10cSrcweir /** allows to specify the suggested file name that is used next time SaveAs 510*cdf0e10cSrcweir dialog is opened 511*cdf0e10cSrcweir 512*cdf0e10cSrcweir <p> 513*cdf0e10cSrcweir If the parameter is specified, the file name will be suggested by 514*cdf0e10cSrcweir SaveAs dialog next time. 515*cdf0e10cSrcweir </p> 516*cdf0e10cSrcweir */ 517*cdf0e10cSrcweir [optional,property] string SuggestedSaveAsName; 518*cdf0e10cSrcweir 519*cdf0e10cSrcweir //------------------------------------------------------------------------- 520*cdf0e10cSrcweir /** name of the template instead of the URL 521*cdf0e10cSrcweir 522*cdf0e10cSrcweir <p> 523*cdf0e10cSrcweir The logical name of a template to load. Together with the <member>MediaDescriptor::TemplateRegion</member> 524*cdf0e10cSrcweir property it can be used instead of the URL of the template. Use always in conjunction with 525*cdf0e10cSrcweir <member>MediaDescriptor::TemplateRegionName</member>. 526*cdf0e10cSrcweir </p> 527*cdf0e10cSrcweir */ 528*cdf0e10cSrcweir [optional,property] string TemplateName; 529*cdf0e10cSrcweir 530*cdf0e10cSrcweir //------------------------------------------------------------------------- 531*cdf0e10cSrcweir /** name of the template instead of the URL 532*cdf0e10cSrcweir 533*cdf0e10cSrcweir <p> 534*cdf0e10cSrcweir The logical name of a template to load. Together with the <member>MediaDescriptor::TemplateRegion</member> 535*cdf0e10cSrcweir property it can be used instead of the URL of the template. Use always in conjunction with 536*cdf0e10cSrcweir <member>MediaDescriptor::TemplateRegionName</member>. 537*cdf0e10cSrcweir </p> 538*cdf0e10cSrcweir */ 539*cdf0e10cSrcweir [optional,property] string TemplateRegionName; 540*cdf0e10cSrcweir 541*cdf0e10cSrcweir //------------------------------------------------------------------------- 542*cdf0e10cSrcweir /** regulate using of compressing 543*cdf0e10cSrcweir 544*cdf0e10cSrcweir <p> 545*cdf0e10cSrcweir For storing: Setting this to <TRUE/> means, don't use a zip file to save 546*cdf0e10cSrcweir the document, use a folder instead (only usable for UCB contents, that 547*cdf0e10cSrcweir support folders). Default is <FALSE/>. 548*cdf0e10cSrcweir </p> 549*cdf0e10cSrcweir */ 550*cdf0e10cSrcweir [optional,property] boolean Unpacked; 551*cdf0e10cSrcweir 552*cdf0e10cSrcweir //------------------------------------------------------------------------- 553*cdf0e10cSrcweir /** URL of the document 554*cdf0e10cSrcweir 555*cdf0e10cSrcweir <p> 556*cdf0e10cSrcweir The location of the component in URL syntax. It must be the full qualified URL and 557*cdf0e10cSrcweir must include f.e. an optional <member>MediaDescriptor::JumpMark</member> too. 558*cdf0e10cSrcweir </p> 559*cdf0e10cSrcweir */ 560*cdf0e10cSrcweir [optional,property] string URL; 561*cdf0e10cSrcweir 562*cdf0e10cSrcweir //------------------------------------------------------------------------- 563*cdf0e10cSrcweir /** storage version 564*cdf0e10cSrcweir 565*cdf0e10cSrcweir <p> 566*cdf0e10cSrcweir For components supporting versioning: the number of the version to be 567*cdf0e10cSrcweir loaded or saved. Default is zero and means: no version is created or 568*cdf0e10cSrcweir loaded, the "main" document is processed. 569*cdf0e10cSrcweir </p> 570*cdf0e10cSrcweir */ 571*cdf0e10cSrcweir [optional,property] short Version; 572*cdf0e10cSrcweir 573*cdf0e10cSrcweir //------------------------------------------------------------------------- 574*cdf0e10cSrcweir /** set special view state 575*cdf0e10cSrcweir <p> 576*cdf0e10cSrcweir Data to set a special view state after loading. The type depends on 577*cdf0e10cSrcweir the component and is usually retrieved from a <type scope="com::sun::star::frame">Controller</type> 578*cdf0e10cSrcweir object by its <type scope="com::sun::star::frame">XController</type> 579*cdf0e10cSrcweir interface. Default is: no view data. 580*cdf0e10cSrcweir </p> 581*cdf0e10cSrcweir */ 582*cdf0e10cSrcweir [optional,property] any ViewData; 583*cdf0e10cSrcweir 584*cdf0e10cSrcweir //------------------------------------------------------------------------- 585*cdf0e10cSrcweir /** id of the initial view 586*cdf0e10cSrcweir 587*cdf0e10cSrcweir <p> 588*cdf0e10cSrcweir For components supporting different views: a number to define the view 589*cdf0e10cSrcweir that should be constructed after loading. Default is: zero, and this 590*cdf0e10cSrcweir should be treated by the component as the default view. 591*cdf0e10cSrcweir </p> 592*cdf0e10cSrcweir */ 593*cdf0e10cSrcweir [optional,property] short ViewId; 594*cdf0e10cSrcweir 595*cdf0e10cSrcweir //------------------------------------------------------------------------- 596*cdf0e10cSrcweir /** should the macro be executed. 597*cdf0e10cSrcweir the value should be one from <type scope="com::sun::star::document">MacroExecMode</type> 598*cdf0e10cSrcweir constant list. 599*cdf0e10cSrcweir 600*cdf0e10cSrcweir @since OOo 1.1.2 601*cdf0e10cSrcweir */ 602*cdf0e10cSrcweir [optional,property] short MacroExecutionMode; 603*cdf0e10cSrcweir 604*cdf0e10cSrcweir //------------------------------------------------------------------------- 605*cdf0e10cSrcweir /** can the document be updated depending from links. 606*cdf0e10cSrcweir the value should be one from <type scope="com::sun::star::document">UpdateDocMode</type> 607*cdf0e10cSrcweir constant list. 608*cdf0e10cSrcweir 609*cdf0e10cSrcweir @since OOo 1.1.2 610*cdf0e10cSrcweir */ 611*cdf0e10cSrcweir [optional,property] short UpdateDocMode; 612*cdf0e10cSrcweir 613*cdf0e10cSrcweir //------------------------------------------------------------------------- 614*cdf0e10cSrcweir /** specifies the name of the view controller to create when loading a document 615*cdf0e10cSrcweir 616*cdf0e10cSrcweir <p>If this property is used when loading a document into a frame, then it 617*cdf0e10cSrcweir specifies the name of the view controller to create. That is, the property 618*cdf0e10cSrcweir is passed to the document's <member scope="com::sun::star::frame">XModel2::createViewController</member> 619*cdf0e10cSrcweir method.<br/> 620*cdf0e10cSrcweir If the loaded document does not support the <code>XModel2</code> interface, 621*cdf0e10cSrcweir the property is ignored.</p> 622*cdf0e10cSrcweir 623*cdf0e10cSrcweir @see ::com::sun::star::frame::XModel2::createViewController 624*cdf0e10cSrcweir @see ::com::sun::star::frame::XController2::ViewControllerName 625*cdf0e10cSrcweir 626*cdf0e10cSrcweir @since OOo 3.0 627*cdf0e10cSrcweir */ 628*cdf0e10cSrcweir [optional,property] string ViewControllerName; 629*cdf0e10cSrcweir //------------------------------------------------------------------------- 630*cdf0e10cSrcweir 631*cdf0e10cSrcweir /** specifies the frame containing the document. May be empty. 632*cdf0e10cSrcweir */ 633*cdf0e10cSrcweir [optional,property] com::sun::star::frame::XFrame Frame; 634*cdf0e10cSrcweir}; 635*cdf0e10cSrcweir 636*cdf0e10cSrcweir//============================================================================= 637*cdf0e10cSrcweir 638*cdf0e10cSrcweir}; }; }; }; 639*cdf0e10cSrcweir 640*cdf0e10cSrcweir#endif 641