offapi/com/sun/star/sheet/Spreadsheet.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 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** represents a complete spreadsheet in a spreadsheet document.
  25
  26     <p>This service extents the service SheetCellRange. A spreadsheet is
  27     nothing else than a cell range with extended functionality.</p>
  28
  29     @see com::sun::star::sheet::SpreadsheetDocument
  30  */
  31 service Spreadsheet
  32 {
  33
  34     /** provides functionality for cell range handling.
  35      */
  36     service com::sun::star::sheet::SheetCellRange;
  37
  38
  39     service com::sun::star::sheet::Scenario;
  40
  41
  42     /** provides methods to create a cell cursor.
  43      */
  44     interface com::sun::star::sheet::XSpreadsheet;
  45
  46
  47     /** provides accessing the spreadsheet name.
  48      */
  49     interface com::sun::star::container::XNamed;
  50
  51
  52     /** provides methods to protect and unprotect the sheet contents.
  53      */
  54     interface com::sun::star::util::XProtectable;
  55
  56
  57     /** provides access to the collection of DataPilot tables.
  58      */
  59     interface com::sun::star::sheet::XDataPilotTablesSupplier;
  60
  61
  62     /** provides access to the collection of scenarios.
  63      */
  64     interface com::sun::star::sheet::XScenariosSupplier;
  65
  66
  67     /** provides access to the collection of annotations.
  68      */
  69     interface com::sun::star::sheet::XSheetAnnotationsSupplier;
  70
  71
  72     /** provides access to the draw page of this spreadsheet.
  73      */
  74     interface com::sun::star::drawing::XDrawPageSupplier;
  75
  76
  77     /** provides access to the collection of chart objects.
  78      */
  79     interface com::sun::star::table::XTableChartsSupplier;
  80
  81
  82     /** provides methods to move cell ranges inside the spreadsheet or to
  83         other spreadsheets in this document.
  84      */
  85     interface com::sun::star::sheet::XCellRangeMovement;
  86
  87
  88     /** provides access to the print area settings of this sheet.
  89      */
  90     interface com::sun::star::sheet::XPrintAreas;
  91
  92
  93     /** provides access to the page breaks of this sheet.
  94      */
  95     interface com::sun::star::sheet::XSheetPageBreak;
  96
  97
  98     /** provides access to row and column outline settings.
  99      */
 100     interface com::sun::star::sheet::XSheetOutline;
 101
 102
 103     /** provides access to the auditing (detective) functionality.
 104      */
 105     interface com::sun::star::sheet::XSheetAuditing;
 106
 107
 108     /** provides methods for a linked sheet.
 109      */
 110     interface com::sun::star::sheet::XSheetLinkable;
 111
 112
 113     /** provides a method to set an external name at the sheet.
 114
 115         @since OOo 3.0
 116      */
 117     [optional] interface com::sun::star::sheet::XExternalSheetName;
 118
 119
 120     /** specifies if the sheet is visible.
 121      */
 122     [property] boolean IsVisible;
 123
 124
 125     /** specifies the page style of the sheet.
 126      */
 127     [property] string PageStyle;
 128
 129
 130     /** specifies the direction of the columns in the spreadsheet.
 131
 132         <p>Possible values are com::sun::star::text::WritingMode2::LR_TB to
 133         order the columns from left to right, and
 134             com::sun::star::text::WritingMode2::RL_TB to order the columns from
 135         right to left.</p>
 136
 137         @see com::sun::star::text::WritingMode2
 138      */
 139     [optional, property] short TableLayout;
 140
 141
 142     /** specifies whether the sheet has an automatic print area.
 143
 144     <p> The automatic print area is used to print a sheet without
 145         explicit print areas, also if other sheets have print areas.</p>
 146
 147     <p> If the property is true, and there are print areas on other sheets,
 148         the used area of this sheet is also printed.</p>
 149
 150     <p> If the property is false, and there are print areas on other sheets,
 151         only these specified print areas are printed.</p>
 152
 153     <p> If there are no print areas on the other sheets it does not matter
 154         whether property is true or false.</p>
 155
 156     <p> This property can only be true, if there are no print areas given
 157         on this sheet. If the property is set to true the print areas of
 158         this sheet will be removed.</p>
 159
 160         @see XPrintAreas
 161
 162      */
 163     [optional, property] boolean AutomaticPrintArea;
 164
 165     /** specifies the color of the sheet tab, if any.
 166      */
 167     [optional, property] com::sun::star::util::Color TabColor;
 168
 169     /** specifies all conditional formats of that sheet
 170      */
 171     [optional, property] com::sun::star::sheet::XConditionalFormats ConditionalFormats;
 172
 173     /** specifies whether summary rows appear below detail in an outline,
 174         when applying an outline.
 175
 176     <p> When true a summary row is inserted below the detailed data being
 177         summarized and a new outline level is established on that row.</p>
 178
 179     <p> When false a summary row is inserted above the detailed data being
 180         summarized and a new outline level is established on that row.</p>
 181
 182         @since LibreOffice 25.2
 183     */
 184     [optional, property] boolean TotalsRowBelow;
 185 };
 186
 187
 188 }; }; }; };
 189
 190 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */