offapi/com/sun/star/sheet/SpreadsheetDocument.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 #ifndef __com_sun_star_sheet_SpreadsheetDocument_idl__
  21 #define __com_sun_star_sheet_SpreadsheetDocument_idl__
  22
  23 #include <com/sun/star/document/OfficeDocument.idl>
  24 #include <com/sun/star/sheet/SpreadsheetDocumentSettings.idl>
  25
  26
  27 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  28 #include <com/sun/star/frame/XModel.idl>
  29 #include <com/sun/star/document/XActionLockable.idl>
  30 #include <com/sun/star/document/XLinkTargetSupplier.idl>
  31 #include <com/sun/star/util/XProtectable.idl>
  32 #include <com/sun/star/sheet/XSpreadsheetDocument.idl>
  33 #include <com/sun/star/sheet/XCalculatable.idl>
  34 #include <com/sun/star/sheet/XDocumentAuditing.idl>
  35 #include <com/sun/star/sheet/XConsolidatable.idl>
  36 #include <com/sun/star/sheet/XGoalSeek.idl>
  37 #include <com/sun/star/drawing/XDrawPagesSupplier.idl>
  38 #include <com/sun/star/style/XStyleFamiliesSupplier.idl>
  39 #include <com/sun/star/util/XNumberFormatsSupplier.idl>
  40
  41
  42 #include <com/sun/star/sheet/XNamedRanges.idl>
  43 #include <com/sun/star/sheet/XDatabaseRanges.idl>
  44 #include <com/sun/star/sheet/XLabelRanges.idl>
  45 #include <com/sun/star/container/XNameAccess.idl>
  46 #include <com/sun/star/sheet/XAreaLinks.idl>
  47 #include <com/sun/star/sheet/XExternalDocLinks.idl>
  48
  49
  50 module com {  module sun {  module star {  module sheet {
  51
  52
  53 /** represents a model component which consists of some settings and
  54     one or more spreadsheets.
  55  */
  56 published service SpreadsheetDocument
  57 {
  58
  59     /** common service for all types of documents.
  60      */
  61     service com::sun::star::document::OfficeDocument;
  62
  63
  64     /** contributes spreadsheet document specific properties.
  65
  66     @deprecated
  67      */
  68     [optional] service com::sun::star::sheet::SpreadsheetDocumentSettings;
  69
  70
  71     /** provides methods to create instances of several spreadsheet
  72         services.
  73      */
  74     interface com::sun::star::lang::XMultiServiceFactory;
  75
  76
  77     /** provides common methods for a document model.
  78
  79         <p>This interface is derived from
  80         com::sun::star::lang::XComponent.</p>
  81      */
  82     interface com::sun::star::frame::XModel;
  83
  84
  85     /** provides methods to control the automatic update of cell contents.
  86      */
  87     interface com::sun::star::document::XActionLockable;
  88
  89
  90     /** provides access to the collection of link targets available in
  91         the document.
  92      */
  93     interface com::sun::star::document::XLinkTargetSupplier;
  94
  95
  96     /** provides methods to protect and unprotect the document.
  97      */
  98     interface com::sun::star::util::XProtectable;
  99
 100
 101     /** provides access to the collection of spreadsheets.
 102      */
 103     interface com::sun::star::sheet::XSpreadsheetDocument;
 104
 105
 106     /** controls the recalculation settings of the document.
 107      */
 108     interface com::sun::star::sheet::XCalculatable;
 109
 110
 111     /** provides a method to refresh all auditing arrows.
 112      */
 113     interface com::sun::star::sheet::XDocumentAuditing;
 114
 115
 116     /** provides methods to perform a data consolidation.
 117      */
 118     interface com::sun::star::sheet::XConsolidatable;
 119
 120
 121     /** provides a method to perform a goal seek.
 122      */
 123     interface com::sun::star::sheet::XGoalSeek;
 124
 125
 126     /** provides access to the collection of draw pages of this document.
 127      */
 128     interface com::sun::star::drawing::XDrawPagesSupplier;
 129
 130
 131     /** provides access to the collection of style families.
 132
 133         <p>A spreadsheet document contains 2 families of styles:
 134         "PageStyles" and "CellStyles".</p>
 135      */
 136     interface com::sun::star::style::XStyleFamiliesSupplier;
 137
 138
 139     /** provides access to the collection of number formats contained in
 140         the document.
 141      */
 142     interface com::sun::star::util::XNumberFormatsSupplier;
 143
 144
 145     /** contains the collection of named ranges in the document.
 146      */
 147     [readonly, property] com::sun::star::sheet::XNamedRanges NamedRanges;
 148
 149
 150     /** contains the collection of database ranges in the document.
 151      */
 152     [readonly, property] com::sun::star::sheet::XDatabaseRanges DatabaseRanges;
 153
 154
 155     /** contains the collection of column label ranges in the document.
 156      */
 157     [readonly, property] com::sun::star::sheet::XLabelRanges ColumnLabelRanges;
 158
 159
 160     /** contains the collection of row label ranges in the document.
 161      */
 162     [readonly, property] com::sun::star::sheet::XLabelRanges RowLabelRanges;
 163
 164
 165     /** contains the collection of sheet links in the document.
 166      */
 167     [readonly, property] com::sun::star::container::XNameAccess SheetLinks;
 168
 169
 170     /** contains the collection of area links in the document.
 171      */
 172     [readonly, property] com::sun::star::sheet::XAreaLinks AreaLinks;
 173
 174
 175     /** contains the collection of DDE links in the document.
 176      */
 177     [readonly, property] com::sun::star::container::XNameAccess DDELinks;
 178
 179
 180 //  /** contains the collection of external document links in the document.
 181 //
 182 //      @since OOo 3.1
 183 //   */
 184 //  [optional, readonly, property] com::sun::star::sheet::XExternalDocLinks ExternalDocLinks;
 185 };
 186
 187
 188 }; }; }; };
 189
 190 #endif
 191
 192 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */