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