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