offapi/com/sun/star/sheet/SpreadsheetDocument.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: SpreadsheetDocument.idl,v $
  10  * $Revision: 1.9.114.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
  31 #ifndef __com_sun_star_sheet_SpreadsheetDocument_idl__
  32 #define __com_sun_star_sheet_SpreadsheetDocument_idl__
  33
  34 #ifndef __com_sun_star_document_OfficeDocument_idl__
  35 #include <com/sun/star/document/OfficeDocument.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_SpreadsheetDocumentSettings_idl__
  39 #include <com/sun/star/sheet/SpreadsheetDocumentSettings.idl>
  40 #endif
  41
  42
  43 #ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
  44 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  45 #endif
  46
  47 #ifndef __com_sun_star_frame_XModel_idl__
  48 #include <com/sun/star/frame/XModel.idl>
  49 #endif
  50
  51 #ifndef __com_sun_star_document_XActionLockable_idl__
  52 #include <com/sun/star/document/XActionLockable.idl>
  53 #endif
  54
  55 #ifndef __com_sun_star_document_XLinkTargetSupplier_idl__
  56 #include <com/sun/star/document/XLinkTargetSupplier.idl>
  57 #endif
  58
  59 #ifndef __com_sun_star_util_XProtectable_idl__
  60 #include <com/sun/star/util/XProtectable.idl>
  61 #endif
  62
  63 #ifndef __com_sun_star_sheet_XSpreadsheetDocument_idl__
  64 #include <com/sun/star/sheet/XSpreadsheetDocument.idl>
  65 #endif
  66
  67 #ifndef __com_sun_star_sheet_XCalculatable_idl__
  68 #include <com/sun/star/sheet/XCalculatable.idl>
  69 #endif
  70
  71 #ifndef __com_sun_star_sheet_XDocumentAuditing_idl__
  72 #include <com/sun/star/sheet/XDocumentAuditing.idl>
  73 #endif
  74
  75 #ifndef __com_sun_star_sheet_XConsolidatable_idl__
  76 #include <com/sun/star/sheet/XConsolidatable.idl>
  77 #endif
  78
  79 #ifndef __com_sun_star_sheet_XGoalSeek_idl__
  80 #include <com/sun/star/sheet/XGoalSeek.idl>
  81 #endif
  82
  83 #ifndef __com_sun_star_drawing_XDrawPagesSupplier_idl__
  84 #include <com/sun/star/drawing/XDrawPagesSupplier.idl>
  85 #endif
  86
  87 #ifndef __com_sun_star_style_XStyleFamiliesSupplier_idl__
  88 #include <com/sun/star/style/XStyleFamiliesSupplier.idl>
  89 #endif
  90
  91 #ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__
  92 #include <com/sun/star/util/XNumberFormatsSupplier.idl>
  93 #endif
  94
  95
  96 #ifndef __com_sun_star_sheet_XNamedRanges_idl__
  97 #include <com/sun/star/sheet/XNamedRanges.idl>
  98 #endif
  99
 100 #ifndef __com_sun_star_sheet_XDatabaseRanges_idl__
 101 #include <com/sun/star/sheet/XDatabaseRanges.idl>
 102 #endif
 103
 104 #ifndef __com_sun_star_sheet_XLabelRanges_idl__
 105 #include <com/sun/star/sheet/XLabelRanges.idl>
 106 #endif
 107
 108 #ifndef __com_sun_star_container_XNameAccess_idl__
 109 #include <com/sun/star/container/XNameAccess.idl>
 110 #endif
 111
 112 #ifndef __com_sun_star_sheet_XAreaLinks_idl__
 113 #include <com/sun/star/sheet/XAreaLinks.idl>
 114 #endif
 115
 116 #ifndef __com_sun_star_sheet_XExternalDocLinks_idl__
 117 #include <com/sun/star/sheet/XExternalDocLinks.idl>
 118 #endif
 119
 120 //=============================================================================
 121
 122 module com {  module sun {  module star {  module sheet {
 123
 124 //=============================================================================
 125
 126 /** represents a model component which consists of some settings and
 127     one or more spreadsheets.
 128  */
 129 published service SpreadsheetDocument
 130 {
 131     //-------------------------------------------------------------------------
 132
 133     /** common service for all types of documents.
 134      */
 135     service com::sun::star::document::OfficeDocument;
 136
 137     //-------------------------------------------------------------------------
 138
 139     /** contributes spreadsheet document specific properties.
 140
 141     @deprecated
 142      */
 143     [optional] service com::sun::star::sheet::SpreadsheetDocumentSettings;
 144
 145     //=========================================================================
 146
 147     /** provides methods to create instances of several spreadsheet
 148         services.
 149      */
 150     interface com::sun::star::lang::XMultiServiceFactory;
 151
 152     //-------------------------------------------------------------------------
 153
 154     /** provides common methods for a document model.
 155
 156         <p>This interface is derived from
 157         <type scope="com::sun::star::lang">XComponent</type>.</p>
 158      */
 159     interface com::sun::star::frame::XModel;
 160
 161     //-------------------------------------------------------------------------
 162
 163     /** provides methods to control the automatic update of cell contents.
 164      */
 165     interface com::sun::star::document::XActionLockable;
 166
 167     //-------------------------------------------------------------------------
 168
 169     /** provides access to the collection of link targets available in
 170         the document.
 171      */
 172     interface com::sun::star::document::XLinkTargetSupplier;
 173
 174     //-------------------------------------------------------------------------
 175
 176     /** provides methods to protect and unprotect the document.
 177      */
 178     interface com::sun::star::util::XProtectable;
 179
 180     //-------------------------------------------------------------------------
 181
 182     /** provides access to the collection of spreadsheets.
 183      */
 184     interface com::sun::star::sheet::XSpreadsheetDocument;
 185
 186     //-------------------------------------------------------------------------
 187
 188     /** controls the recalculation settings of the document.
 189      */
 190     interface com::sun::star::sheet::XCalculatable;
 191
 192     //-------------------------------------------------------------------------
 193
 194     /** provides a method to refresh all auditing arrows.
 195      */
 196     interface com::sun::star::sheet::XDocumentAuditing;
 197
 198     //-------------------------------------------------------------------------
 199
 200     /** provides methods to perform a data consolidation.
 201      */
 202     interface com::sun::star::sheet::XConsolidatable;
 203
 204     //-------------------------------------------------------------------------
 205
 206     /** provides a method to perform a goal seek.
 207      */
 208     interface com::sun::star::sheet::XGoalSeek;
 209
 210     //-------------------------------------------------------------------------
 211
 212     /** provides access to the collection of draw pages of this document.
 213      */
 214     interface com::sun::star::drawing::XDrawPagesSupplier;
 215
 216     //-------------------------------------------------------------------------
 217
 218     /** provides access to the collection of style families.
 219
 220         <p>A spreadsheet document contains 2 families of styles:
 221         "PageStyles" and "CellStyles".</p>
 222      */
 223     interface com::sun::star::style::XStyleFamiliesSupplier;
 224
 225     //-------------------------------------------------------------------------
 226
 227     /** provides access to the collection of number formats contained in
 228         the document.
 229      */
 230     interface com::sun::star::util::XNumberFormatsSupplier;
 231
 232     //=========================================================================
 233
 234     /** contains the collection of named ranges in the document.
 235      */
 236     [readonly, property] com::sun::star::sheet::XNamedRanges NamedRanges;
 237
 238     //-------------------------------------------------------------------------
 239
 240     /** contains the collection of database ranges in the document.
 241      */
 242     [readonly, property] com::sun::star::sheet::XDatabaseRanges DatabaseRanges;
 243
 244     //-------------------------------------------------------------------------
 245
 246     /** contains the collection of column label ranges in the document.
 247      */
 248     [readonly, property] com::sun::star::sheet::XLabelRanges ColumnLabelRanges;
 249
 250     //-------------------------------------------------------------------------
 251
 252     /** contains the collection of row label ranges in the document.
 253      */
 254     [readonly, property] com::sun::star::sheet::XLabelRanges RowLabelRanges;
 255
 256     //-------------------------------------------------------------------------
 257
 258     /** contains the collection of sheet links in the document.
 259      */
 260     [readonly, property] com::sun::star::container::XNameAccess SheetLinks;
 261
 262     //-------------------------------------------------------------------------
 263
 264     /** contains the collection of area links in the document.
 265      */
 266     [readonly, property] com::sun::star::sheet::XAreaLinks AreaLinks;
 267
 268     //-------------------------------------------------------------------------
 269
 270     /** contains the collection of DDE links in the document.
 271      */
 272     [readonly, property] com::sun::star::container::XNameAccess DDELinks;
 273
 274     //-------------------------------------------------------------------------
 275
 276 #if 0
 277     /** contains the collection of external document links in the document.
 278
 279         @since OOo 3.1
 280      */
 281     [optional, readonly, property] com::sun::star::sheet::XExternalDocLinks ExternalDocLinks;
 282 #endif
 283
 284 };
 285
 286 //=============================================================================
 287
 288 }; }; }; };
 289
 290 #endif
 291