/************************************************************** * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * *************************************************************/ #ifndef __com_sun_star_sheet_SheetCellRanges_idl__ #define __com_sun_star_sheet_SheetCellRanges_idl__ #ifndef __com_sun_star_table_CellProperties_idl__ #include #endif #ifndef __com_sun_star_style_CharacterProperties_idl__ #include #endif #ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__ #include #endif #ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__ #include #endif #ifndef __com_sun_star_style_ParagraphProperties_idl__ #include #endif #ifndef __com_sun_star_sheet_SheetRangesQuery_idl__ #include #endif #ifndef __com_sun_star_util_XReplaceable_idl__ #include #endif #ifndef __com_sun_star_util_XIndent_idl__ #include #endif #ifndef __com_sun_star_sheet_XSheetOperation_idl__ #include #endif #ifndef __com_sun_star_chart_XChartDataArray_idl__ #include #endif #ifndef __com_sun_star_sheet_XSheetCellRangeContainer_idl__ #include #endif #ifndef __com_sun_star_container_XEnumerationAccess_idl__ #include #endif #ifndef __com_sun_star_container_XNameContainer_idl__ #include #endif #ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__ #include #endif #ifndef __com_sun_star_beans_XPropertySet_idl__ #include #endif //============================================================================= module com { module sun { module star { module sheet { //============================================================================= /** represents a collection of cell ranges in a spreadsheet document. @see com::sun::star::sheet::SheetCellRange */ published service SheetCellRanges { //------------------------------------------------------------------------- /** contributes common cell formatting properties. */ service com::sun::star::table::CellProperties; //------------------------------------------------------------------------- /** contributes properties for character formatting of Western text. */ service com::sun::star::style::CharacterProperties; //------------------------------------------------------------------------- /** contributes properties for character formatting of Asian text. */ service com::sun::star::style::CharacterPropertiesAsian; //------------------------------------------------------------------------- /** contributes properties for character formatting of Complex text. */ service com::sun::star::style::CharacterPropertiesComplex; //------------------------------------------------------------------------- /** contributes properties for paragraph formatting. */ service com::sun::star::style::ParagraphProperties; //------------------------------------------------------------------------- /** provides interfaces to find cells with specific properties. */ service com::sun::star::sheet::SheetRangesQuery; //========================================================================= /** provides "Find & Replace" functionality.

The property SearchDescriptor::SearchWords has a different meaning in spreadsheets: If set to , the spreadsheet searches for cells containing the serch text only.

*/ interface com::sun::star::util::XReplaceable; //------------------------------------------------------------------------- /** provides modifying the cell indentation. */ interface com::sun::star::util::XIndent; //------------------------------------------------------------------------- /** provides computation of a value based on the contents of all cells of this range and to clear specific cells. */ interface com::sun::star::sheet::XSheetOperation; //------------------------------------------------------------------------- /** provides modifying the source data cells of a chart and makes it possible to learn about changes in the cell values. */ interface com::sun::star::chart::XChartDataArray; //------------------------------------------------------------------------- /** provides methods to access cell ranges via index and to add and remove cell ranges. */ interface com::sun::star::sheet::XSheetCellRangeContainer; //------------------------------------------------------------------------- /** creates an enumeration of all cell ranges. @see com::sun::star::sheet::SheetCellRangesEnumeration */ interface com::sun::star::container::XEnumerationAccess; //------------------------------------------------------------------------- /** provides access of the cell ranges via an user-defined name.

Later the range can be found, replaced or removed using that name.

*/ interface com::sun::star::container::XNameContainer; //========================================================================= /** contains the conditional formatting settings for this cell.

After a conditional format has been changed it has to be reinserted into the property set.

@see com::sun::star::sheet::TableConditionalFormat */ [property] com::sun::star::sheet::XSheetConditionalEntries ConditionalFormat; //------------------------------------------------------------------------- /** contains the conditional formatting settings for this cell, using localized formulas.

After a conditional format has been changed it has to be reinserted into the property set.

@see com::sun::star::sheet::TableConditionalFormat */ [optional, property] com::sun::star::sheet::XSheetConditionalEntries ConditionalFormatLocal; //------------------------------------------------------------------------- /** contains the data validation settings for this cell.

After the data validation settings have been changed the validation has to be reinserted into the property set.

@see com::sun::star::sheet::TableValidation */ [property] com::sun::star::beans::XPropertySet Validation; //------------------------------------------------------------------------- /** contains the data validation settings for this cell, using localized formulas.

After the data validation settings have been changed the validation has to be reinserted into the property set.

@see com::sun::star::sheet::TableValidation */ [optional, property] com::sun::star::beans::XPropertySet ValidationLocal; //------------------------------------------------------------------------- /** Returns the absolute address of the ranges as string, e.g. "$Sheet1.$B$2:$D$5". */ [optional, readonly, property] string AbsoluteName; }; //============================================================================= }; }; }; }; #endif