offapi/com/sun/star/sheet/Spreadsheet.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: Spreadsheet.idl,v $
  10  * $Revision: 1.12 $
  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_Spreadsheet_idl__
  32 #define __com_sun_star_sheet_Spreadsheet_idl__
  33
  34 #ifndef __com_sun_star_sheet_SheetCellRange_idl__
  35 #include <com/sun/star/sheet/SheetCellRange.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_XSpreadsheet_idl__
  39 #include <com/sun/star/sheet/XSpreadsheet.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_container_XNamed_idl__
  43 #include <com/sun/star/container/XNamed.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_util_XProtectable_idl__
  47 #include <com/sun/star/util/XProtectable.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_sheet_XDataPilotTablesSupplier_idl__
  51 #include <com/sun/star/sheet/XDataPilotTablesSupplier.idl>
  52 #endif
  53
  54 #ifndef __com_sun_star_sheet_XScenariosSupplier_idl__
  55 #include <com/sun/star/sheet/XScenariosSupplier.idl>
  56 #endif
  57
  58 #ifndef __com_sun_star_sheet_XSheetAnnotationsSupplier_idl__
  59 #include <com/sun/star/sheet/XSheetAnnotationsSupplier.idl>
  60 #endif
  61
  62 #ifndef __com_sun_star_drawing_XDrawPageSupplier_idl__
  63 #include <com/sun/star/drawing/XDrawPageSupplier.idl>
  64 #endif
  65
  66 #ifndef __com_sun_star_table_XTableChartsSupplier_idl__
  67 #include <com/sun/star/table/XTableChartsSupplier.idl>
  68 #endif
  69
  70 #ifndef __com_sun_star_sheet_XCellRangeMovement_idl__
  71 #include <com/sun/star/sheet/XCellRangeMovement.idl>
  72 #endif
  73
  74 #ifndef __com_sun_star_sheet_XPrintAreas_idl__
  75 #include <com/sun/star/sheet/XPrintAreas.idl>
  76 #endif
  77
  78 #ifndef __com_sun_star_sheet_XSheetPageBreak_idl__
  79 #include <com/sun/star/sheet/XSheetPageBreak.idl>
  80 #endif
  81
  82 #ifndef __com_sun_star_sheet_XSheetOutline_idl__
  83 #include <com/sun/star/sheet/XSheetOutline.idl>
  84 #endif
  85
  86 #ifndef __com_sun_star_sheet_XSheetAuditing_idl__
  87 #include <com/sun/star/sheet/XSheetAuditing.idl>
  88 #endif
  89
  90 #ifndef __com_sun_star_sheet_XSheetLinkable_idl__
  91 #include <com/sun/star/sheet/XSheetLinkable.idl>
  92 #endif
  93
  94 #ifndef __com_sun_star_sheet_Scenario_idl__
  95 #include <com/sun/star/sheet/Scenario.idl>
  96 #endif
  97
  98 #ifndef __com_sun_star_sheet_XExternalSheetName_idl__
  99 #include <com/sun/star/sheet/XExternalSheetName.idl>
 100 #endif
 101
 102 //=============================================================================
 103
 104 module com {  module sun {  module star {  module sheet {
 105
 106 //=============================================================================
 107
 108 /** represents a complete spreadsheet in a spreadsheet document.
 109
 110     <p>This service extents the service SheetCellRange. A spreadsheet is
 111     nothing else than a cell range with extended functionality.</p>
 112
 113     @see com::sun::star::sheet::SpreadsheetDocument
 114  */
 115 service Spreadsheet
 116 {
 117     //-------------------------------------------------------------------------
 118
 119     /** provides functionality for cell range handling.
 120      */
 121     service com::sun::star::sheet::SheetCellRange;
 122
 123     //=========================================================================
 124
 125     service com::sun::star::sheet::Scenario;
 126
 127     //=========================================================================
 128
 129     /** provides methods to create a cell cursor.
 130      */
 131     interface com::sun::star::sheet::XSpreadsheet;
 132
 133     //-------------------------------------------------------------------------
 134
 135     /** provides accessing the spreadsheet name.
 136      */
 137     interface com::sun::star::container::XNamed;
 138
 139     //-------------------------------------------------------------------------
 140
 141     /** provides methods to protect and unprotect the sheet contents.
 142      */
 143     interface com::sun::star::util::XProtectable;
 144
 145     //-------------------------------------------------------------------------
 146
 147     /** provides access to the collection of DataPilot tables.
 148      */
 149     interface com::sun::star::sheet::XDataPilotTablesSupplier;
 150
 151     //-------------------------------------------------------------------------
 152
 153     /** provides access to the collection of scenarios.
 154      */
 155     interface com::sun::star::sheet::XScenariosSupplier;
 156
 157         //-------------------------------------------------------------------------
 158
 159     /** provides access to the collection of annotations.
 160      */
 161     interface com::sun::star::sheet::XSheetAnnotationsSupplier;
 162
 163     //-------------------------------------------------------------------------
 164
 165     /** provides access to the draw page of this spreadsheet.
 166      */
 167     interface com::sun::star::drawing::XDrawPageSupplier;
 168
 169     //-------------------------------------------------------------------------
 170
 171     /** provides access to the collection of chart objects.
 172      */
 173     interface com::sun::star::table::XTableChartsSupplier;
 174
 175     //-------------------------------------------------------------------------
 176
 177     /** provides methods to move cell ranges inside the spreadsheet or to
 178         other spreadsheets in this document.
 179      */
 180     interface com::sun::star::sheet::XCellRangeMovement;
 181
 182     //-------------------------------------------------------------------------
 183
 184     /** provides access to the print area settings of this sheet.
 185      */
 186     interface com::sun::star::sheet::XPrintAreas;
 187
 188     //-------------------------------------------------------------------------
 189
 190     /** provides access to the page breaks of this sheet.
 191      */
 192     interface com::sun::star::sheet::XSheetPageBreak;
 193
 194     //-------------------------------------------------------------------------
 195
 196     /** provides access to row and column outline settings.
 197      */
 198     interface com::sun::star::sheet::XSheetOutline;
 199
 200     //-------------------------------------------------------------------------
 201
 202     /** provides access to the auditing (detective) functionality.
 203      */
 204     interface com::sun::star::sheet::XSheetAuditing;
 205
 206     //-------------------------------------------------------------------------
 207
 208     /** provides methods for a linked sheet.
 209      */
 210     interface com::sun::star::sheet::XSheetLinkable;
 211
 212     //-------------------------------------------------------------------------
 213
 214     /** provides a method to set an external name at the sheet.
 215
 216         @since OOo 3.0
 217      */
 218     [optional] interface com::sun::star::sheet::XExternalSheetName;
 219
 220     //=========================================================================
 221
 222     /** specifies if the sheet is visible.
 223      */
 224     [property] boolean IsVisible;
 225
 226     //-------------------------------------------------------------------------
 227
 228     /** specifies the page style of the sheet.
 229      */
 230     [property] string PageStyle;
 231
 232     //-------------------------------------------------------------------------
 233
 234     /** specifies the direction of the columns in the spreadsheet.
 235
 236         <p>Possible values are com::sun::star::text::WritingMode2::LR_TB to
 237         order the columns from left to right, and
 238             com::sun::star::text::WritingMode2::RL_TB to order the columns from
 239         right to left.</p>
 240
 241         @see com::sun::star::text::WritingMode2
 242      */
 243     [optional, property] short TableLayout;
 244
 245     //-------------------------------------------------------------------------
 246
 247     /** specifies whether the sheet has an automatic print area.
 248
 249     <p> The automatic print area is used to print a sheet without
 250         explicit print areas, also if other sheets have print areas.</p>
 251
 252     <p> If the property is true, and there are print areas on other sheets,
 253         the used area of this sheet is also printed.</p>
 254
 255     <p> If the property is false, and there are print areas on other sheets,
 256         only these specified print areas are printed.</p>
 257
 258     <p> If there are no print areas on the other sheets it does not matter
 259         whether property is true or false.</p>
 260
 261     <p> This property can only be true, if there are no print areas given
 262         on this sheet. If the property is set to true the print areas of
 263         this sheet will be removed.</p>
 264
 265         @see XPrintAreas
 266
 267      */
 268     [optional, property] boolean AutomaticPrintArea;
 269
 270 };
 271
 272 //=============================================================================
 273
 274 }; }; }; };
 275
 276 #endif
 277