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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: OfficeDocument.idl,v $
  10  * $Revision: 1.17.12.2 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_document_OfficeDocument_idl__
  31 #define __com_sun_star_document_OfficeDocument_idl__
  32
  33 #ifndef __com_sun_star_frame_XModel_idl__
  34 #include <com/sun/star/frame/XModel.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_util_XModifiable_idl__
  38 #include <com/sun/star/util/XModifiable.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_frame_XStorable_idl__
  42 #include <com/sun/star/frame/XStorable.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_view_XPrintable_idl__
  46 #include <com/sun/star/view/XPrintable.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_view_XPrintJobBroadcaster_idl__
  50 #include <com/sun/star/view/XPrintJobBroadcaster.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_document_XEventBroadcaster_idl__
  54 #include <com/sun/star/document/XEventBroadcaster.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_document_XEventsSupplier_idl__
  58 #include <com/sun/star/document/XEventsSupplier.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_document_XDocumentInfoSupplier_idl__
  62 #include <com/sun/star/document/XDocumentInfoSupplier.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_document_XViewDataSupplier_idl__
  66 #include <com/sun/star/document/XViewDataSupplier.idl>
  67 #endif
  68
  69 #ifndef __com_sun_star_document_XDocumentEventBroadcaster_idl__
  70 #include <com/sun/star/document/XDocumentEventBroadcaster.idl>
  71 #endif
  72
  73 #ifndef __com_sun_star_document_XEmbeddedScripts_idl__
  74 #include <com/sun/star/document/XEmbeddedScripts.idl>
  75 #endif
  76
  77 //=============================================================================
  78
  79 module com {   module sun {   module star {   module document {
  80
  81 //=============================================================================
  82 /** abstract service which specifies a storable and printable document
  83
  84     <p>
  85     All major document-like components should support this service
  86     instead of simple components which supports a <type scope="com::sun::star::frame">Controller</type>
  87     or pure <type scope="com::sun::star::awt">XWindow</type> only.
  88     </p>
  89
  90     @see com::sun::star::frame::Controller
  91  */
  92 published service OfficeDocument
  93 {
  94     //-------------------------------------------------------------------------
  95     /** represents a component which is created from an URL and arguments
  96
  97         <p>
  98         It is a representation of a resource in the sense that it was
  99         created/loaded from the resource. The arguments are passed to the loader
 100         to modify its behavior.
 101         </p>
 102      */
 103     interface com::sun::star::frame::XModel;
 104
 105     //-------------------------------------------------------------------------
 106     /** a storable document should provide information about his modify state
 107
 108         <p>
 109         With this interface it's possible too, to reset the modify state.
 110         That can be neccessary to prevent code against problem during closing
 111         of the document without saving any changes.
 112         </p>
 113      */
 114     interface com::sun::star::util::XModifiable;
 115
 116     //-------------------------------------------------------------------------
 117     /** offers a simple way to store a component to an URL
 118
 119         <p>
 120         This interface supports functionality
 121         <ul>
 122             <li>to make a copy of current component by saving it to another location</li>
 123             <li>to commit made changes</li>
 124             <li>to convert it by saving it by using suitable filter name.</li>
 125         </ul>
 126         </p>
 127      */
 128     interface com::sun::star::frame::XStorable;
 129
 130     //-------------------------------------------------------------------------
 131     /** offers a way to print a component
 132
 133         <p>
 134         It's possible to specify wich printer should be used and of course
 135         print the document on it.
 136         </p>
 137      */
 138     interface com::sun::star::view::XPrintable;
 139
 140     //-------------------------------------------------------------------------
 141     /** is an old and deprecated version of the <type>XDocumentEventBroadcaster</type> interface
 142         @deprecated
 143      */
 144     [optional] interface XEventBroadcaster;
 145
 146     //-------------------------------------------------------------------------
 147     /** makes it possible to register listeners which are called whenever
 148         a document event occurs
 149      */
 150     [optional] interface XDocumentEventBroadcaster;
 151
 152     //-------------------------------------------------------------------------
 153     /** access to bound event handlers
 154      */
 155     [optional] interface XEventsSupplier;
 156
 157     //-------------------------------------------------------------------------
 158     /** document can provide a <type>DocumentInfo</type>
 159
 160         <p>
 161         Instead of the <type>StandaloneDocumentInfo</type> service the <type>DocumentInfo</type>
 162         will be available on an already opened document only.
 163         </p>
 164      */
 165     [optional] interface XDocumentInfoSupplier;
 166
 167     //-------------------------------------------------------------------------
 168     /** access to some properties describing all open views to a document
 169      */
 170     [optional] interface XViewDataSupplier;
 171
 172     //-------------------------------------------------------------------------
 173     /** allows for getting information about a print job
 174
 175         @since OOo 1.1.2
 176      */
 177     [optional] interface com::sun::star::view::XPrintJobBroadcaster;
 178
 179     /** is supported when the document can contain scripts and dialogs
 180
 181         @since OOo 2.4
 182     */
 183     [optional] interface XEmbeddedScripts;
 184
 185     //-------------------------------------------------------------------------
 186     /** controls the focus behaviour of the form controls in the document
 187
 188         <p>
 189         If this flag is set to <TRUE/>, any view belonging to the document
 190         should focus the first control in the document. With this, you may
 191         control if your document works primarily as a form document.
 192         </p>
 193     */
 194     [property, optional] boolean AutomaticControlFocus;
 195
 196     //-------------------------------------------------------------------------
 197     /** controls the initial (on-load) behavior of the form controls in the document
 198
 199         <p>If set to <TRUE/>, upon loading the document, the form controls will be in design mode.<br/>
 200         If set to <FALSE/>, they will be alive, i.e. operational.<br/>
 201         With this, you may control if your document works primarily as a form document.
 202         </p>
 203     */
 204     [property, optional] boolean ApplyFormDesignMode;
 205
 206     //-------------------------------------------------------------------------
 207     /** contains a unique id for the document
 208
 209         <p>Once calculated, the id must not change until the document has been
 210         closed. Upon closing it will not be made persistent. Thus, the document
 211         may get a different id every time it gets loaded.</p>
 212     */
 213     [property, optional, readonly] string RuntimeUID;
 214 };
 215
 216 //=============================================================================
 217
 218 }; }; }; };
 219
 220 #endif