offapi/com/sun/star/sheet/SheetCellRanges.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_SheetCellRanges_idl__
  29 #define __com_sun_star_sheet_SheetCellRanges_idl__
  30
  31
  32 #ifndef __com_sun_star_table_CellProperties_idl__
  33 #include <com/sun/star/table/CellProperties.idl>
  34 #endif
  35
  36 #ifndef __com_sun_star_style_CharacterProperties_idl__
  37 #include <com/sun/star/style/CharacterProperties.idl>
  38 #endif
  39
  40 #ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__
  41 #include <com/sun/star/style/CharacterPropertiesAsian.idl>
  42 #endif
  43
  44 #ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__
  45 #include <com/sun/star/style/CharacterPropertiesComplex.idl>
  46 #endif
  47
  48 #ifndef __com_sun_star_style_ParagraphProperties_idl__
  49 #include <com/sun/star/style/ParagraphProperties.idl>
  50 #endif
  51
  52 #ifndef __com_sun_star_sheet_SheetRangesQuery_idl__
  53 #include <com/sun/star/sheet/SheetRangesQuery.idl>
  54 #endif
  55
  56
  57 #ifndef __com_sun_star_util_XReplaceable_idl__
  58 #include <com/sun/star/util/XReplaceable.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_util_XIndent_idl__
  62 #include <com/sun/star/util/XIndent.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_sheet_XSheetOperation_idl__
  66 #include <com/sun/star/sheet/XSheetOperation.idl>
  67 #endif
  68
  69 #ifndef __com_sun_star_chart_XChartDataArray_idl__
  70 #include <com/sun/star/chart/XChartDataArray.idl>
  71 #endif
  72
  73 #ifndef __com_sun_star_sheet_XSheetCellRangeContainer_idl__
  74 #include <com/sun/star/sheet/XSheetCellRangeContainer.idl>
  75 #endif
  76
  77 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  78 #include <com/sun/star/container/XEnumerationAccess.idl>
  79 #endif
  80
  81 #ifndef __com_sun_star_container_XNameContainer_idl__
  82 #include <com/sun/star/container/XNameContainer.idl>
  83 #endif
  84
  85
  86 #ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__
  87 #include <com/sun/star/sheet/XSheetConditionalEntries.idl>
  88 #endif
  89
  90 #ifndef __com_sun_star_beans_XPropertySet_idl__
  91 #include <com/sun/star/beans/XPropertySet.idl>
  92 #endif
  93
  94 //=============================================================================
  95
  96 module com {  module sun {  module star {  module sheet {
  97
  98 //=============================================================================
  99
 100 /** represents a collection of cell ranges in a spreadsheet document.
 101
 102     @see com::sun::star::sheet::SheetCellRange
 103  */
 104 published service SheetCellRanges
 105 {
 106     //-------------------------------------------------------------------------
 107
 108     /** contributes common cell formatting properties.
 109      */
 110     service com::sun::star::table::CellProperties;
 111
 112     //-------------------------------------------------------------------------
 113
 114     /** contributes properties for character formatting of Western text.
 115      */
 116     service com::sun::star::style::CharacterProperties;
 117
 118     //-------------------------------------------------------------------------
 119
 120     /** contributes properties for character formatting of Asian text.
 121      */
 122     service com::sun::star::style::CharacterPropertiesAsian;
 123
 124     //-------------------------------------------------------------------------
 125
 126     /** contributes properties for character formatting of Complex text.
 127      */
 128     service com::sun::star::style::CharacterPropertiesComplex;
 129
 130     //-------------------------------------------------------------------------
 131
 132     /** contributes properties for paragraph formatting.
 133      */
 134     service com::sun::star::style::ParagraphProperties;
 135
 136     //-------------------------------------------------------------------------
 137
 138     /** provides interfaces to find cells with specific properties.
 139      */
 140     service com::sun::star::sheet::SheetRangesQuery;
 141
 142     //=========================================================================
 143
 144     /** provides "Find & Replace" functionality.
 145
 146         <p>The property
 147         <member scope="com::sun::star::util">SearchDescriptor::SearchWords</member>
 148         has a different meaning in spreadsheets: If set to <TRUE/>, the
 149         spreadsheet searches for cells containing the serch text only.</p>
 150      */
 151     interface com::sun::star::util::XReplaceable;
 152
 153     //-------------------------------------------------------------------------
 154
 155     /** provides modifying the cell indentation.
 156      */
 157     interface com::sun::star::util::XIndent;
 158
 159     //-------------------------------------------------------------------------
 160
 161     /** provides computation of a value based on the contents of all
 162         cells of this range and to clear specific cells.
 163      */
 164     interface com::sun::star::sheet::XSheetOperation;
 165
 166     //-------------------------------------------------------------------------
 167
 168     /** provides modifying the source data cells of a chart and makes
 169         it possible to learn about changes in the cell values.
 170      */
 171     interface com::sun::star::chart::XChartDataArray;
 172
 173     //-------------------------------------------------------------------------
 174
 175     /** provides methods to access cell ranges via index and to add and
 176         remove cell ranges.
 177      */
 178     interface com::sun::star::sheet::XSheetCellRangeContainer;
 179
 180     //-------------------------------------------------------------------------
 181
 182     /** creates an enumeration of all cell ranges.
 183
 184         @see com::sun::star::sheet::SheetCellRangesEnumeration
 185      */
 186     interface com::sun::star::container::XEnumerationAccess;
 187
 188     //-------------------------------------------------------------------------
 189
 190     /** provides access of the cell ranges via an user-defined name.
 191
 192         <p>Later the range can be found, replaced or removed using that
 193         name.</p>
 194      */
 195     interface com::sun::star::container::XNameContainer;
 196
 197     //=========================================================================
 198
 199     /** contains the conditional formatting settings for this cell.
 200
 201         <p>After a conditional format has been changed it has to be
 202         reinserted into the property set.</p>
 203
 204         @see com::sun::star::sheet::TableConditionalFormat
 205      */
 206     [property] com::sun::star::sheet::XSheetConditionalEntries
 207         ConditionalFormat;
 208
 209     //-------------------------------------------------------------------------
 210
 211     /** contains the conditional formatting settings for this cell,
 212         using localized formulas.
 213
 214         <p>After a conditional format has been changed it has to be
 215         reinserted into the property set.</p>
 216
 217         @see com::sun::star::sheet::TableConditionalFormat
 218      */
 219     [optional, property] com::sun::star::sheet::XSheetConditionalEntries
 220         ConditionalFormatLocal;
 221
 222     //-------------------------------------------------------------------------
 223
 224     /** contains the data validation settings for this cell.
 225
 226         <p>After the data validation settings have been changed the
 227         validation has to be reinserted into the property set.</p>
 228
 229         @see com::sun::star::sheet::TableValidation
 230      */
 231     [property] com::sun::star::beans::XPropertySet Validation;
 232
 233     //-------------------------------------------------------------------------
 234
 235     /** contains the data validation settings for this cell,
 236         using localized formulas.
 237
 238         <p>After the data validation settings have been changed the
 239         validation has to be reinserted into the property set.</p>
 240
 241         @see com::sun::star::sheet::TableValidation
 242      */
 243     [optional, property] com::sun::star::beans::XPropertySet ValidationLocal;
 244
 245     //-------------------------------------------------------------------------
 246
 247     /** Returns the absolute adress of the ranges as string, e.g. "$Sheet1.$B$2:$D$5".
 248      */
 249     [optional, readonly, property] string AbsoluteName;
 250 };
 251
 252 //=============================================================================
 253
 254 }; }; }; };
 255
 256 #endif
 257