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