diff options
Diffstat (limited to 'offapi/com/sun/star/sheet/XSheetCellRanges.idl')
| -rw-r--r-- | offapi/com/sun/star/sheet/XSheetCellRanges.idl | 160 |
1 files changed, 63 insertions, 97 deletions
diff --git a/offapi/com/sun/star/sheet/XSheetCellRanges.idl b/offapi/com/sun/star/sheet/XSheetCellRanges.idl index 2f907fa43..89ef2e570 100644 --- a/offapi/com/sun/star/sheet/XSheetCellRanges.idl +++ b/offapi/com/sun/star/sheet/XSheetCellRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetCellRanges.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,103 +58,69 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetCellRanges_idl__ -#define __com_sun_star_sheet_XSheetCellRanges_idl__ - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> -#endif - -#ifndef __com_sun_star_container_XEnumerationAccess_idl__ -#include <com/sun/star/container/XEnumerationAccess.idl> -#endif - -#ifndef __com_sun_star_table_CellRangeAddress_idl__ -#include <com/sun/star/table/CellRangeAddress.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetCellRanges -/** represents multiple cell ranges.@see com::sun::star::sheet::SheetCellRanges + +#ifndef __com_sun_star_sheet_XSheetCellRanges_idl__ +#define __com_sun_star_sheet_XSheetCellRanges_idl__ + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif + +#ifndef __com_sun_star_table_CellRangeAddress_idl__ +#include <com/sun/star/table/CellRangeAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to access cell ranges in a collection via index and + other helper methods. + + @see com::sun::star::sheet::SheetCellRanges */ interface XSheetCellRanges: com::sun::star::container::XIndexAccess -{ - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::sheet::XSheetCellRanges::getCells - /** returns the EnumerationAccess of the cells. - - @returns - the EnumerationAccess of the cells. - - @see com::sun::star::sheet::Cells +{ + //------------------------------------------------------------------------- + + /** returns the collection of all used cells. + + @see com::sun::star::sheet::Cells */ - com::sun::star::container::XEnumerationAccess getCells(); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetCellRanges::getRangeAddressesAsString - - // DocMerge from xml: method com::sun::star::sheet::XSheetCellRanges::getRangeAddressesAsString - /** returns a string describing the addresses of the cell ranges. - - - <p>The string could have the form "Sheet1.A1:C3;Sheet2.D5:F8".</p> + com::sun::star::container::XEnumerationAccess getCells(); + + //------------------------------------------------------------------------- + + /** creates a string with addresses of all contained cell ranges. + + <p>The range addresses are separated with semicolons. For instance + the string could have the form "Sheet1.A1:C3;Sheet2.D5:F8".</p> + + @returns + a string containing the addresses of all cell ranges. */ - string getRangeAddressesAsString(); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetCellRanges::getRangeAddresses - - // DocMerge from idl: method com::sun::star::sheet::XSheetCellRanges::getRangeAddresses - /** returns the addresses of the cell ranges. - - @returns - the addresses. + string getRangeAddressesAsString(); + + //------------------------------------------------------------------------- + + /** creates a sequence with addresses of all contained cell ranges. + + @returns + a sequence with the addresses of all cell ranges. */ - sequence<com::sun::star::table::CellRangeAddress> getRangeAddresses(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.6 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.4 2000/03/24 17:35:24 nn - #74032# documentation added - - Revision 1.3 2000/02/09 14:59:03 mi - #72869# get/setCellStyle moved to CellProperties - - Revision 1.2 2000/02/07 11:24:56 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + sequence<com::sun::star::table::CellRangeAddress> getRangeAddresses(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + |