offapi/com/sun/star/sheet/SheetCellRanges.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: SheetCellRanges.idl,v $
  10  * $Revision: 1.9 $
  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_SheetCellRanges_idl__
  32 #define __com_sun_star_sheet_SheetCellRanges_idl__
  33
  34
  35 #ifndef __com_sun_star_table_CellProperties_idl__
  36 #include <com/sun/star/table/CellProperties.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_style_CharacterProperties_idl__
  40 #include <com/sun/star/style/CharacterProperties.idl>
  41 #endif
  42
  43 #ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__
  44 #include <com/sun/star/style/CharacterPropertiesAsian.idl>
  45 #endif
  46
  47 #ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__
  48 #include <com/sun/star/style/CharacterPropertiesComplex.idl>
  49 #endif
  50
  51 #ifndef __com_sun_star_style_ParagraphProperties_idl__
  52 #include <com/sun/star/style/ParagraphProperties.idl>
  53 #endif
  54
  55 #ifndef __com_sun_star_sheet_SheetRangesQuery_idl__
  56 #include <com/sun/star/sheet/SheetRangesQuery.idl>
  57 #endif
  58
  59
  60 #ifndef __com_sun_star_util_XReplaceable_idl__
  61 #include <com/sun/star/util/XReplaceable.idl>
  62 #endif
  63
  64 #ifndef __com_sun_star_util_XIndent_idl__
  65 #include <com/sun/star/util/XIndent.idl>
  66 #endif
  67
  68 #ifndef __com_sun_star_sheet_XSheetOperation_idl__
  69 #include <com/sun/star/sheet/XSheetOperation.idl>
  70 #endif
  71
  72 #ifndef __com_sun_star_chart_XChartDataArray_idl__
  73 #include <com/sun/star/chart/XChartDataArray.idl>
  74 #endif
  75
  76 #ifndef __com_sun_star_sheet_XSheetCellRangeContainer_idl__
  77 #include <com/sun/star/sheet/XSheetCellRangeContainer.idl>
  78 #endif
  79
  80 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  81 #include <com/sun/star/container/XEnumerationAccess.idl>
  82 #endif
  83
  84 #ifndef __com_sun_star_container_XNameContainer_idl__
  85 #include <com/sun/star/container/XNameContainer.idl>
  86 #endif
  87
  88
  89 #ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__
  90 #include <com/sun/star/sheet/XSheetConditionalEntries.idl>
  91 #endif
  92
  93 #ifndef __com_sun_star_beans_XPropertySet_idl__
  94 #include <com/sun/star/beans/XPropertySet.idl>
  95 #endif
  96
  97 //=============================================================================
  98
  99 module com {  module sun {  module star {  module sheet {
 100
 101 //=============================================================================
 102
 103 /** represents a collection of cell ranges in a spreadsheet document.
 104
 105     @see com::sun::star::sheet::SheetCellRange
 106  */
 107 published service SheetCellRanges
 108 {
 109     //-------------------------------------------------------------------------
 110
 111     /** contributes common cell formatting properties.
 112      */
 113     service com::sun::star::table::CellProperties;
 114
 115     //-------------------------------------------------------------------------
 116
 117     /** contributes properties for character formatting of Western text.
 118      */
 119     service com::sun::star::style::CharacterProperties;
 120
 121     //-------------------------------------------------------------------------
 122
 123     /** contributes properties for character formatting of Asian text.
 124      */
 125     service com::sun::star::style::CharacterPropertiesAsian;
 126
 127     //-------------------------------------------------------------------------
 128
 129     /** contributes properties for character formatting of Complex text.
 130      */
 131     service com::sun::star::style::CharacterPropertiesComplex;
 132
 133     //-------------------------------------------------------------------------
 134
 135     /** contributes properties for paragraph formatting.
 136      */
 137     service com::sun::star::style::ParagraphProperties;
 138
 139     //-------------------------------------------------------------------------
 140
 141     /** provides interfaces to find cells with specific properties.
 142      */
 143     service com::sun::star::sheet::SheetRangesQuery;
 144
 145     //=========================================================================
 146
 147     /** provides "Find & Replace" functionality.
 148
 149         <p>The property
 150         <member scope="com::sun::star::util">SearchDescriptor::SearchWords</member>
 151         has a different meaning in spreadsheets: If set to <TRUE/>, the
 152         spreadsheet searches for cells containing the serch text only.</p>
 153      */
 154     interface com::sun::star::util::XReplaceable;
 155
 156     //-------------------------------------------------------------------------
 157
 158     /** provides modifying the cell indentation.
 159      */
 160     interface com::sun::star::util::XIndent;
 161
 162     //-------------------------------------------------------------------------
 163
 164     /** provides computation of a value based on the contents of all
 165         cells of this range and to clear specific cells.
 166      */
 167     interface com::sun::star::sheet::XSheetOperation;
 168
 169     //-------------------------------------------------------------------------
 170
 171     /** provides modifying the source data cells of a chart and makes
 172         it possible to learn about changes in the cell values.
 173      */
 174     interface com::sun::star::chart::XChartDataArray;
 175
 176     //-------------------------------------------------------------------------
 177
 178     /** provides methods to access cell ranges via index and to add and
 179         remove cell ranges.
 180      */
 181     interface com::sun::star::sheet::XSheetCellRangeContainer;
 182
 183     //-------------------------------------------------------------------------
 184
 185     /** creates an enumeration of all cell ranges.
 186
 187         @see com::sun::star::sheet::SheetCellRangesEnumeration
 188      */
 189     interface com::sun::star::container::XEnumerationAccess;
 190
 191     //-------------------------------------------------------------------------
 192
 193     /** provides access of the cell ranges via an user-defined name.
 194
 195         <p>Later the range can be found, replaced or removed using that
 196         name.</p>
 197      */
 198     interface com::sun::star::container::XNameContainer;
 199
 200     //=========================================================================
 201
 202     /** contains the conditional formatting settings for this cell.
 203
 204         <p>After a conditional format has been changed it has to be
 205         reinserted into the property set.</p>
 206
 207         @see com::sun::star::sheet::TableConditionalFormat
 208      */
 209     [property] com::sun::star::sheet::XSheetConditionalEntries
 210         ConditionalFormat;
 211
 212     //-------------------------------------------------------------------------
 213
 214     /** contains the conditional formatting settings for this cell,
 215         using localized formulas.
 216
 217         <p>After a conditional format has been changed it has to be
 218         reinserted into the property set.</p>
 219
 220         @see com::sun::star::sheet::TableConditionalFormat
 221      */
 222     [optional, property] com::sun::star::sheet::XSheetConditionalEntries
 223         ConditionalFormatLocal;
 224
 225     //-------------------------------------------------------------------------
 226
 227     /** contains the data validation settings for this cell.
 228
 229         <p>After the data validation settings have been changed the
 230         validation has to be reinserted into the property set.</p>
 231
 232         @see com::sun::star::sheet::TableValidation
 233      */
 234     [property] com::sun::star::beans::XPropertySet Validation;
 235
 236     //-------------------------------------------------------------------------
 237
 238     /** contains the data validation settings for this cell,
 239         using localized formulas.
 240
 241         <p>After the data validation settings have been changed the
 242         validation has to be reinserted into the property set.</p>
 243
 244         @see com::sun::star::sheet::TableValidation
 245      */
 246     [optional, property] com::sun::star::beans::XPropertySet ValidationLocal;
 247
 248     //-------------------------------------------------------------------------
 249
 250     /** Returns the absolute adress of the ranges as string, e.g. "$Sheet1.$B$2:$D$5".
 251      */
 252     [optional, readonly, property] string AbsoluteName;
 253 };
 254
 255 //=============================================================================
 256
 257 }; }; }; };
 258
 259 #endif
 260