offapi/com/sun/star/sheet/SheetCellRanges.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 #ifndef __com_sun_star_sheet_SheetCellRanges_idl__
  21 #define __com_sun_star_sheet_SheetCellRanges_idl__
  22
  23
  24 #include <com/sun/star/table/CellProperties.idl>
  25 #include <com/sun/star/style/CharacterProperties.idl>
  26 #include <com/sun/star/style/CharacterPropertiesAsian.idl>
  27 #include <com/sun/star/style/CharacterPropertiesComplex.idl>
  28 #include <com/sun/star/style/ParagraphProperties.idl>
  29 #include <com/sun/star/sheet/SheetRangesQuery.idl>
  30
  31
  32 #include <com/sun/star/util/XReplaceable.idl>
  33 #include <com/sun/star/util/XIndent.idl>
  34 #include <com/sun/star/sheet/XSheetOperation.idl>
  35 #include <com/sun/star/chart/XChartDataArray.idl>
  36 #include <com/sun/star/sheet/XSheetCellRangeContainer.idl>
  37 #include <com/sun/star/container/XEnumerationAccess.idl>
  38 #include <com/sun/star/container/XNameContainer.idl>
  39
  40
  41 #include <com/sun/star/sheet/XSheetConditionalEntries.idl>
  42 #include <com/sun/star/beans/XPropertySet.idl>
  43
  44
  45 module com {  module sun {  module star {  module sheet {
  46
  47
  48 /** represents a collection of cell ranges in a spreadsheet document.
  49
  50     @see com::sun::star::sheet::SheetCellRange
  51  */
  52 published service SheetCellRanges
  53 {
  54
  55     /** contributes common cell formatting properties.
  56      */
  57     service com::sun::star::table::CellProperties;
  58
  59
  60     /** contributes properties for character formatting of Western text.
  61      */
  62     service com::sun::star::style::CharacterProperties;
  63
  64
  65     /** contributes properties for character formatting of Asian text.
  66      */
  67     service com::sun::star::style::CharacterPropertiesAsian;
  68
  69
  70     /** contributes properties for character formatting of Complex text.
  71      */
  72     service com::sun::star::style::CharacterPropertiesComplex;
  73
  74
  75     /** contributes properties for paragraph formatting.
  76      */
  77     service com::sun::star::style::ParagraphProperties;
  78
  79
  80     /** provides interfaces to find cells with specific properties.
  81      */
  82     service com::sun::star::sheet::SheetRangesQuery;
  83
  84
  85     /** provides "Find & Replace" functionality.
  86
  87         <p>The property
  88         com::sun::star::util::SearchDescriptor::SearchWords
  89         has a different meaning in spreadsheets: If set to `TRUE`, the
  90         spreadsheet searches for cells containing the search text only.</p>
  91      */
  92     interface com::sun::star::util::XReplaceable;
  93
  94
  95     /** provides modifying the cell indentation.
  96      */
  97     interface com::sun::star::util::XIndent;
  98
  99
 100     /** provides computation of a value based on the contents of all
 101         cells of this range and to clear specific cells.
 102      */
 103     interface com::sun::star::sheet::XSheetOperation;
 104
 105
 106     /** provides modifying the source data cells of a chart and makes
 107         it possible to learn about changes in the cell values.
 108      */
 109     interface com::sun::star::chart::XChartDataArray;
 110
 111
 112     /** provides methods to access cell ranges via index and to add and
 113         remove cell ranges.
 114      */
 115     interface com::sun::star::sheet::XSheetCellRangeContainer;
 116
 117
 118     /** creates an enumeration of all cell ranges.
 119
 120         @see com::sun::star::sheet::SheetCellRangesEnumeration
 121      */
 122     interface com::sun::star::container::XEnumerationAccess;
 123
 124
 125     /** provides access of the cell ranges via an user-defined name.
 126
 127         <p>Later the range can be found, replaced or removed using that
 128         name.</p>
 129      */
 130     interface com::sun::star::container::XNameContainer;
 131
 132
 133     /** contains the conditional formatting settings for this cell.
 134
 135         <p>After a conditional format has been changed it has to be
 136         reinserted into the property set.</p>
 137
 138         @see com::sun::star::sheet::TableConditionalFormat
 139      */
 140     [property] com::sun::star::sheet::XSheetConditionalEntries
 141         ConditionalFormat;
 142
 143
 144     /** contains the conditional formatting settings for this cell,
 145         using localized formulas.
 146
 147         <p>After a conditional format has been changed it has to be
 148         reinserted into the property set.</p>
 149
 150         @see com::sun::star::sheet::TableConditionalFormat
 151      */
 152     [optional, property] com::sun::star::sheet::XSheetConditionalEntries
 153         ConditionalFormatLocal;
 154
 155
 156     /** contains the data validation settings for this cell.
 157
 158         <p>After the data validation settings have been changed the
 159         validation has to be reinserted into the property set.</p>
 160
 161         @see com::sun::star::sheet::TableValidation
 162      */
 163     [property] com::sun::star::beans::XPropertySet Validation;
 164
 165
 166     /** contains the data validation settings for this cell,
 167         using localized formulas.
 168
 169         <p>After the data validation settings have been changed the
 170         validation has to be reinserted into the property set.</p>
 171
 172         @see com::sun::star::sheet::TableValidation
 173      */
 174     [optional, property] com::sun::star::beans::XPropertySet ValidationLocal;
 175
 176
 177     /** Returns the absolute address of the ranges as string, e.g. "$Sheet1.$B$2:$D$5".
 178      */
 179     [optional, readonly, property] string AbsoluteName;
 180 };
 181
 182
 183 }; }; }; };
 184
 185 #endif
 186
 187 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */