offapi/com/sun/star/document/OfficeDocument.idl

   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
  23 /** abstract service which specifies a storable and printable document
  24
  25     <p>
  26     All major document-like components should support this service
  27     instead of simple components which supports a com::sun::star::frame::Controller
  28     or pure com::sun::star::awt::XWindow only.
  29     </p>
  30
  31     @see com::sun::star::frame::Controller
  32  */
  33 published service OfficeDocument
  34 {
  35     /** represents a component which is created from a URL and arguments
  36
  37         <p>
  38         It is a representation of a resource in the sense that it was
  39         created/loaded from the resource. The arguments are passed to the loader
  40         to modify its behavior.
  41         </p>
  42      */
  43     interface com::sun::star::frame::XModel;
  44
  45     /** a storable document should provide information about his modify state
  46
  47         <p>
  48         With this interface it's possible too, to reset the modify state.
  49         That can be necessary to prevent code against problem during closing
  50         of the document without saving any changes.
  51         </p>
  52      */
  53     interface com::sun::star::util::XModifiable;
  54
  55     /** offers a simple way to store a component to a URL
  56
  57         <p>
  58         This interface supports functionality
  59         <ul>
  60             <li>to make a copy of current component by saving it to another location</li>
  61             <li>to commit made changes</li>
  62             <li>to convert it by saving it by using suitable filter name.</li>
  63         </ul>
  64         </p>
  65      */
  66     interface com::sun::star::frame::XStorable;
  67
  68     /** offers a way to print a component
  69
  70         <p>
  71         It's possible to specify which printer should be used and of course
  72         print the document on it.
  73         </p>
  74      */
  75     interface com::sun::star::view::XPrintable;
  76
  77     /** is an old and deprecated version of the XDocumentEventBroadcaster interface
  78         @deprecated
  79      */
  80     [optional] interface XEventBroadcaster;
  81
  82     /** makes it possible to register listeners which are called whenever
  83         a document event occurs
  84      */
  85     [optional] interface XDocumentEventBroadcaster;
  86
  87     /** access to bound event handlers
  88      */
  89     [optional] interface XEventsSupplier;
  90
  91     /** access to some properties describing all open views to a document
  92      */
  93     [optional] interface XViewDataSupplier;
  94
  95     /** allows for getting information about a print job
  96
  97         @since OOo 1.1.2
  98      */
  99     [optional] interface com::sun::star::view::XPrintJobBroadcaster;
 100
 101     /** is supported when the document can contain scripts and dialogs
 102
 103         @since OOo 2.4
 104     */
 105     [optional] interface XEmbeddedScripts;
 106
 107     /** access to the DocumentProperties.
 108
 109         @since OOo 3.0
 110      */
 111     [optional] interface XDocumentPropertiesSupplier;
 112
 113     /** provides access to the document's undo manager.
 114     */
 115     [optional] interface XUndoManagerSupplier;
 116
 117     /** controls the focus behavior of the form controls in the document
 118
 119         <p>
 120         If this flag is set to `TRUE`, any view belonging to the document
 121         should focus the first control in the document. With this, you may
 122         control if your document works primarily as a form document.
 123         </p>
 124     */
 125     [property, optional] boolean AutomaticControlFocus;
 126
 127     /** controls the initial (on-load) behavior of the form controls in the document
 128
 129         <p>If set to `TRUE`, upon loading the document, the form controls will be in design mode.<br/>
 130         If set to `FALSE`, they will be alive, i.e. operational.<br/>
 131         With this, you may control if your document works primarily as a form document.
 132         </p>
 133     */
 134     [property, optional] boolean ApplyFormDesignMode;
 135
 136     /** contains a unique id for the document
 137
 138         <p>Once calculated, the id must not change until the document has been
 139         closed. Upon closing it will not be made persistent. Thus, the document
 140         may get a different id every time it gets loaded.</p>
 141     */
 142     [property, optional, readonly] string RuntimeUID;
 143
 144     /** Grab bag of document properties, used as a string-any map for
 145         interim interop purposes.
 146
 147         @since LibreOffice 4.2
 148
 149         <p>This property is intentionally not handled by the ODF
 150         filter. Any member that should be handled there should be
 151         first moved out from this grab bag to a separate property.</p>
 152     */
 153     [optional, property] sequence<com::sun::star::beans::PropertyValue> InteropGrabBag;
 154 };
 155
 156
 157 }; }; }; };
 158
 159 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */