diff options
Diffstat (limited to 'offapi/com/sun/star/sheet')
207 files changed, 13375 insertions, 12389 deletions
diff --git a/offapi/com/sun/star/sheet/AddIn.idl b/offapi/com/sun/star/sheet/AddIn.idl index dd6e8936f..6e0c4f0a9 100644 --- a/offapi/com/sun/star/sheet/AddIn.idl +++ b/offapi/com/sun/star/sheet/AddIn.idl @@ -2,9 +2,9 @@ * * $RCSfile: AddIn.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: nn $ $Date: 2001-02-19 19:52:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,34 +58,31 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_AddIn_idl__ -#define __com_sun_star_sheet_AddIn_idl__ - -#ifndef __com_sun_star_lang_XServiceName_idl__ -#include <com/sun/star/lang/XServiceName.idl> -#endif - -#ifndef __com_sun_star_sheet_XAddIn_idl__ -#include <com/sun/star/sheet/XAddIn.idl> -#endif - -#ifndef __com_sun_star_sheet_XCompatibilityNames_idl__ -#include <com/sun/star/sheet/XCompatibilityNames.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::AddIn + +#ifndef __com_sun_star_sheet_AddIn_idl__ +#define __com_sun_star_sheet_AddIn_idl__ + +#ifndef __com_sun_star_lang_XServiceName_idl__ +#include <com/sun/star/lang/XServiceName.idl> +#endif + +#ifndef __com_sun_star_sheet_XAddIn_idl__ +#include <com/sun/star/sheet/XAddIn.idl> +#endif + +#ifndef __com_sun_star_sheet_XCompatibilityNames_idl__ +#include <com/sun/star/sheet/XCompatibilityNames.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** is the base for AddIn services that supply functions which can be called by other components. - - - + <p>Any AddIn implementation must implement a service describing its specific set of functions. That service must contain the <type>AddIn</type> service, and the @@ -93,114 +90,72 @@ The <type scope="com::sun::star::lang">XServiceName</type> interface must describe that service, and the <type>XAddIn</type> interface must describe the individual functions.</p> - + <p>Each AddIn function can take parameters of the following types:</p> + <dl> - <dt> - <atom>long</atom> - </dt> - <dd>for integer values. - </dd> - <dt> - <atom>double</atom> - </dt> - <dd>for floating point values. - </dd> - <dt> - <atom>string</atom> - </dt> - <dd>for text strings. - </dd> - <dt> - <atom>long[][]</atom> - </dt> - <dd>for (two-dimensional) arrays of integer values. - </dd> - <dt> - <atom>double[][]</atom> - </dt> - <dd>for (two-dimensional) arrays of floating point values. - </dd> - <dt> - <atom>string[][]</atom> - </dt> - <dd>for (two-dimensional) arrays of text strings. - </dd> - <dt> - <atom>any[][]</atom> - </dt> - <dd>for (two-dimensional) arrays of mixed contents. - Each <atom>any</atom> will contain a <atom>double</atom> - or a <atom>string</atom>, depending on the data. - </dd> - <dt> - <atom>any</atom> - </dt> - <dd>Depending on the data, a <atom>double</atom>, - a <atom>string</atom>, or an - <atom>any[][]</atom> - will be passed. If no argument is specified in the - function call, <void/> will be passed. This allows - for optional parameters. - </dd> - <dt> - <type scope="com::sun::star::table">XCellRange</type> - </dt> - <dd>for a <type scope="com::sun::star::table">XCellRange</type> - interface to the source data. - </dd> - <dt> - <type scope="com::sun::star::beans">XPropertySet</type> - </dt> + <dt><atom>long</atom></dt> + <dd>for integer values.</dd> + + <dt><atom>double</atom></dt> + <dd>for floating point values.</dd> + + <dt><atom>string</atom></dt> + <dd>for text strings.</dd> + + <dt><atom>long[][]</atom></dt> + <dd>for (two-dimensional) arrays of integer values.</dd> + + <dt><atom>double[][]</atom></dt> + <dd>for (two-dimensional) arrays of floating point values.</dd> + + <dt><atom>string[][]</atom></dt> + <dd>for (two-dimensional) arrays of text strings.</dd> + + <dt><atom>any[][]</atom></dt> + <dd>for (two-dimensional) arrays of mixed contents. Each <atom>any</atom> + will contain a <atom>double</atom> or a <atom>string</atom>, depending on + the data.</dd> + + <dt><atom>any</atom></dt> + <dd>Depending on the data, a <atom>double</atom>, a <atom>string</atom>, + or an <atom>any[][]</atom> will be passed. If no argument is specified in + the function call, <void/> will be passed. This allows for optional + parameters.</dd> + + <dt><type scope="com::sun::star::table">XCellRange</type></dt> + <dd>for a <type scope="com::sun::star::table">XCellRange</type> interface + to the source data.</dd> + + <dt><type scope="com::sun::star::beans">XPropertySet</type></dt> <dd>for a <type scope="com::sun::star::beans">XPropertySet</type> - interface to the <type>SpreadsheetDocument</type> - making the function call. Only one parameter of this type - is allowed in each function. It can be used to query - document settings like - <member>SpreadsheetDocumentSettings::NullDate</member>. - </dd> - <dt> - <atom>any[]</atom> - </dt> - <dd>for varying parameters. Only the last parameter of a - function may have this type. It will be filled with the - remaining arguments of the function call that were not - used for the previous parameters. Each element of the - sequence will be filled as in the case of - <atom>any</atom> above. - </dd> + interface to the <type>SpreadsheetDocument</type> making the function + call. Only one parameter of this type is allowed in each function. It + can be used to query document settings like + <member>SpreadsheetDocumentSettings::NullDate</member>.</dd> + + <dt><atom>any[]</atom></dt> + <dd>for varying parameters. Only the last parameter of a function may + have this type. It will be filled with the remaining arguments of the + function call that were not used for the previous parameters. Each + element of the sequence will be filled as in the case of <atom>any</atom> + above.</dd> </dl> - + <p>Each AddIn function must have one of the following return types:</p> + <ul> - <li> - <atom>long</atom> - </li> - <li> - <atom>double</atom> - </li> - <li> - <atom>string</atom> - </li> - <li> - <atom>long[][]</atom> - </li> - <li> - <atom>double[][]</atom> - </li> - <li> - <atom>string[][]</atom> - </li> - <li> - <atom>any[][]</atom> - </li> - <li> - <type>XVolatileResult</type> - </li> - <li> - <atom>any</atom> - </li> + <li><atom>long</atom></li> + <li><atom>double</atom></li> + <li><atom>string</atom></li> + <li><atom>long[][]</atom></li> + <li><atom>double[][]</atom></li> + <li><atom>string[][]</atom></li> + <li><atom>any[][]</atom></li> + <li><type>XVolatileResult</type></li> + <li><atom>any</atom></li> </ul> + <p>The sequences must contain arrays as described above for the parameter types. An <type>XVolatileResult</type> return value must contain an object @@ -210,50 +165,30 @@ An <atom>any</atom> return value can contain any of the other types.</p> */ service AddIn -{ - // DocMerge: empty anyway - interface com::sun::star::lang::XServiceName; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XAddIn; - - /** This optional interface gives access to compatibility names for - the functions. +{ + // ------------------------------------------------------------------------ + + /** contains a method that returns the service name of the add-in. */ - [optional] interface com::sun::star::sheet::XCompatibilityNames; -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/19 13:59:41 mi - syntax errors in documentation fixed - - Revision 1.4 2000/12/19 13:13:17 mi - no dim='[][]' anymore for new document generator - - Revision 1.3 2000/11/08 12:43:45 mi - moved from api - - Revision 1.2 2000/10/05 12:51:28 mi - sequences presentation in documentation as attribute dim=[] - - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.4 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.2 2000/02/07 11:24:53 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + interface com::sun::star::lang::XServiceName; + + // ------------------------------------------------------------------------ + + /** provides access to function descriptions and localized names + and descriptions. + */ + interface com::sun::star::sheet::XAddIn; + + // ------------------------------------------------------------------------ + + /** provides access to compatibility names for the functions. + */ + [optional] interface com::sun::star::sheet::XCompatibilityNames; +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/Border.idl b/offapi/com/sun/star/sheet/Border.idl index aa0b35a48..adb6f4d9d 100644 --- a/offapi/com/sun/star/sheet/Border.idl +++ b/offapi/com/sun/star/sheet/Border.idl @@ -2,9 +2,9 @@ * * $RCSfile: Border.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,67 +58,49 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_Border_idl__ -#define __com_sun_star_sheet_Border_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::Border -/** selects one of the four borders of a cell range. + +#ifndef __com_sun_star_sheet_Border_idl__ +#define __com_sun_star_sheet_Border_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** is used to select one of the four borders of a cell range. */ enum Border -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::Border::TOP - /** The top border. +{ + //------------------------------------------------------------------------- + + /** selects the top border. */ - TOP, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::Border::BOTTOM - /** The bottom border. + TOP, + + //------------------------------------------------------------------------- + + /** selects the bottom border. */ - BOTTOM, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::Border::RIGHT - /** The right border. + BOTTOM, + + //------------------------------------------------------------------------- + + /** selects the right border. */ - RIGHT, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::Border::LEFT - /** The left border. + RIGHT, + + //------------------------------------------------------------------------- + + /** selects the left border. */ - LEFT - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + LEFT + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/CellAnnotation.idl b/offapi/com/sun/star/sheet/CellAnnotation.idl index 689776e2c..a2011c8aa 100644 --- a/offapi/com/sun/star/sheet/CellAnnotation.idl +++ b/offapi/com/sun/star/sheet/CellAnnotation.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellAnnotation.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,56 +58,60 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_CellAnnotation_idl__ -#define __com_sun_star_sheet_CellAnnotation_idl__ - -#ifndef __com_sun_star_text_XText_idl__ -#include <com/sun/star/text/XText.idl> -#endif - -#ifndef __com_sun_star_sheet_XSheetAnnotation_idl__ -#include <com/sun/star/sheet/XSheetAnnotation.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::CellAnnotation -/** an annotation of a cell. + +#ifndef __com_sun_star_sheet_CellAnnotation_idl__ +#define __com_sun_star_sheet_CellAnnotation_idl__ + +#ifndef __com_sun_star_sheet_XSheetAnnotation_idl__ +#include <com/sun/star/sheet/XSheetAnnotation.idl> +#endif + +#ifndef __com_sun_star_container_XChild_idl__ +#include <com/sun/star/container/XChild.idl> +#endif + +#ifndef __com_sun_star_text_XSimpleText_idl__ +#include <com/sun/star/text/XSimpleText.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a cell annotation object attached to a spreadsheet cell. + + @see com::sun::star::sheet::SheetCell */ service CellAnnotation -{ - // DocMerge: empty anyway - interface com::sun::star::text::XSimpleText; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetAnnotation; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.4 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.2 2000/01/28 16:24:53 mi - #72213# XSimpleText - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides methods to query data of the annotation + and to show and hide it. + */ + interface com::sun::star::sheet::XSheetAnnotation; + + //------------------------------------------------------------------------- + + /** provides access to the parent of this object. + + <p>The parent of a cell annotation is the cell that contains it.</p> + */ + interface com::sun::star::container::XChild; + + //------------------------------------------------------------------------- + + /** provides access to the text contents of the annotation. + */ + interface com::sun::star::text::XSimpleText; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/CellAnnotations.idl b/offapi/com/sun/star/sheet/CellAnnotations.idl index 357fa6601..f6eadf1f2 100644 --- a/offapi/com/sun/star/sheet/CellAnnotations.idl +++ b/offapi/com/sun/star/sheet/CellAnnotations.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellAnnotations.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,52 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_CellAnnotations_idl__ -#define __com_sun_star_sheet_CellAnnotations_idl__ - -#ifndef __com_sun_star_sheet_XSheetAnnotations_idl__ -#include <com/sun/star/sheet/XSheetAnnotations.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::CellAnnotations -/** a collection of cell annotations. + +#ifndef __com_sun_star_sheet_CellAnnotations_idl__ +#define __com_sun_star_sheet_CellAnnotations_idl__ + +#ifndef __com_sun_star_sheet_XSheetAnnotations_idl__ +#include <com/sun/star/sheet/XSheetAnnotations.idl> +#endif + +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of cell annotations. + + @see com::sun::star::sheet::Spreadsheet */ service CellAnnotations -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetAnnotations; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides methods to access cell annotations via index and to + insert and remove annotations. + + @see com::sun::star::sheet::CellAnnotation + */ + interface com::sun::star::sheet::XSheetAnnotations; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all cell annotations. + + @see com::sun::star::sheet::CellAnnotationsEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/CellAnnotationsEnumeration.idl b/offapi/com/sun/star/sheet/CellAnnotationsEnumeration.idl new file mode 100644 index 000000000..1cd3fc08d --- /dev/null +++ b/offapi/com/sun/star/sheet/CellAnnotationsEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: CellAnnotationsEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:41 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_CellAnnotationsEnumeration_idl__ +#define __com_sun_star_sheet_CellAnnotationsEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of cell annotations in a spreadsheet document. + + @see com::sun::star::sheet::CellAnnotations + */ +service CellAnnotationsEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the cell annotations in the enumeration. + + @see com::sun::star::sheet::CellAnnotation + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/CellAreaLink.idl b/offapi/com/sun/star/sheet/CellAreaLink.idl index 659c281b6..f74be4ebc 100644 --- a/offapi/com/sun/star/sheet/CellAreaLink.idl +++ b/offapi/com/sun/star/sheet/CellAreaLink.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellAreaLink.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: dr $ $Date: 2001-04-05 10:01:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_CellAreaLink_idl__ #define __com_sun_star_sheet_CellAreaLink_idl__ @@ -73,54 +74,62 @@ #include <com/sun/star/beans/XPropertySet.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::CellAreaLink -/** a linked cell range. +/** represents a linked cell range. + + <p>A linked cell range is a range which is linked to an equal-sized + range in an external document. The contents of the external range is + copied into the range of this document.</p> + + @see com::sun::star::sheet::CellAreaLinks */ service CellAreaLink { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to change the settings of the linked cell range. + */ interface com::sun::star::sheet::XAreaLink; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to reload the external data. + */ interface com::sun::star::util::XRefreshable; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- + //======================================================================== - // DocMerge from xml: property com::sun::star::sheet::CellAreaLink::Url /** specifies the URL of the source document. */ [property] string Url; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::CellAreaLink::Filter - /** specifies the name of the filter needed - to load the source document. + /** specifies the name of the filter used to load the source document. */ [property] string Filter; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::CellAreaLink::FilterOptions - /** specifies the filter options needed - to load the source document. + /** specifies the filter options needed to load the source document. */ [property] string FilterOptions; //------------------------------------------------------------------------- - /** specifies the delay time between - two refresh actions in seconds. + /** specifies the delay time between two refresh actions in seconds. */ [property] long RefreshDelay; @@ -130,27 +139,5 @@ service CellAreaLink }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:45 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.5 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:07 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:53 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/CellAreaLinks.idl b/offapi/com/sun/star/sheet/CellAreaLinks.idl index 44065dfc0..24226701d 100644 --- a/offapi/com/sun/star/sheet/CellAreaLinks.idl +++ b/offapi/com/sun/star/sheet/CellAreaLinks.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellAreaLinks.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,60 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_CellAreaLinks_idl__ -#define __com_sun_star_sheet_CellAreaLinks_idl__ - -#ifndef __com_sun_star_sheet_XAreaLinks_idl__ -#include <com/sun/star/sheet/XAreaLinks.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::CellAreaLinks -/** a collection of area links. + +#ifndef __com_sun_star_sheet_CellAreaLinks_idl__ +#define __com_sun_star_sheet_CellAreaLinks_idl__ + +#ifndef __com_sun_star_sheet_XAreaLinks_idl__ +#include <com/sun/star/sheet/XAreaLinks.idl> +#endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of area links. + + @see com::sun::star::sheet::CellAreaLink + @see com::sun::star::sheet::SpreadsheetDocument */ service CellAreaLinks -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XAreaLinks; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access via index to a collection of area links and inserting + and removing area links. + */ + interface com::sun::star::sheet::XAreaLinks; + + //------------------------------------------------------------------------- + + /** provides access to the area links via index. + + @see com::sun::star::sheet::CellAreaLink + + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all area links. + + @see com::sun::star::sheet::CellAreaLinksEnumeration + + */ + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/CellAreaLinksEnumeration.idl b/offapi/com/sun/star/sheet/CellAreaLinksEnumeration.idl new file mode 100644 index 000000000..97af91438 --- /dev/null +++ b/offapi/com/sun/star/sheet/CellAreaLinksEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: CellAreaLinksEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:41 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_CellAreaLinksEnumeration_idl__ +#define __com_sun_star_sheet_CellAreaLinksEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of cell area links. + + @see com::sun::star::sheet::CellAreaLink + */ +service CellAreaLinksEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the cell area links in the enumeration. + + @see com::sun::star::sheet::CellAreaLink + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/CellDeleteMode.idl b/offapi/com/sun/star/sheet/CellDeleteMode.idl index 0ce60a006..0d0326e11 100644 --- a/offapi/com/sun/star/sheet/CellDeleteMode.idl +++ b/offapi/com/sun/star/sheet/CellDeleteMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellDeleteMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,75 +58,55 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_CellDeleteMode_idl__ -#define __com_sun_star_sheet_CellDeleteMode_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::CellDeleteMode -/** used to specify how cells are moved when cells are - deleted. + +#ifndef __com_sun_star_sheet_CellDeleteMode_idl__ +#define __com_sun_star_sheet_CellDeleteMode_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** is used to specify how remaining cells are moved when cells are deleted. */ enum CellDeleteMode -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::CellDeleteMode::NONE +{ + //------------------------------------------------------------------------- + /** no cells are moved. */ - NONE, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::CellDeleteMode::UP + NONE, + + //------------------------------------------------------------------------- + /** the cells below the deleted cells are moved up. */ - UP, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::CellDeleteMode::LEFT + UP, + + //------------------------------------------------------------------------- + /** the cells to the right of the deleted cells are moved left. */ - LEFT, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::CellDeleteMode::ROWS + LEFT, + + //------------------------------------------------------------------------- + /** entire rows below the deleted cells are moved up. */ - ROWS, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::CellDeleteMode::COLUMNS + ROWS, + + //------------------------------------------------------------------------- + /** entire columns to the right of the deleted cells are moved left. */ - COLUMNS - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + COLUMNS + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/CellFlags.idl b/offapi/com/sun/star/sheet/CellFlags.idl index a3df6f785..3e603f924 100644 --- a/offapi/com/sun/star/sheet/CellFlags.idl +++ b/offapi/com/sun/star/sheet/CellFlags.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellFlags.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,111 +58,85 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_CellFlags_idl__ -#define __com_sun_star_sheet_CellFlags_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from idl: constants com::sun::star::sheet::CellFlags -/** These constants select different types of cell contents. - - <P>The values can be combined. - They are used to insert, copy, or delete contents.</P> + +#ifndef __com_sun_star_sheet_CellFlags_idl__ +#define __com_sun_star_sheet_CellFlags_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** These constants select different types of cell contents. + + <P>The values can be combined. They are used to insert, copy, or + delete contents.</P> */ constants CellFlags -{ - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::CellFlags::VALUE - /** This value selects constant numeric values that are not formatted - as dates or times. +{ + //------------------------------------------------------------------------- + + /** selects constant numeric values that are not formatted + as dates or times. */ - const long VALUE = 1; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::CellFlags::DATETIME - /** This value selects constant numeric values that have a date or time - number format. + const long VALUE = 1; + + //------------------------------------------------------------------------- + + /** selects constant numeric values that have a date or time + number format. */ - const long DATETIME = 2; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::CellFlags::STRING - /** This value selects constant strings. + const long DATETIME = 2; + + //------------------------------------------------------------------------- + + /** selects constant strings. */ - const long STRING = 4; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::CellFlags::ANNOTATION - /** This value selects cell annotations. + const long STRING = 4; + + //------------------------------------------------------------------------- + + /** selects cell annotations. */ - const long ANNOTATION = 8; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::CellFlags::FORMULA - /** This value selects formulas. + const long ANNOTATION = 8; + + //------------------------------------------------------------------------- + + /** selects formulas. */ - const long FORMULA = 16; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::CellFlags::HARDATTR - /** This value selects all explicit formatting, but not the - formatting which is applied implicitly through style sheets. + const long FORMULA = 16; + + //------------------------------------------------------------------------- + + /** selects all explicit formatting, but not the formatting which is + applied implicitly through style sheets. */ - const long HARDATTR = 32; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::CellFlags::STYLES - /** This value selects cell styles. + const long HARDATTR = 32; + + //------------------------------------------------------------------------- + + /** selects cell styles. */ - const long STYLES = 64; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::CellFlags::OBJECTS - /** This value selects drawing objects. + const long STYLES = 64; + + //------------------------------------------------------------------------- + + /** selects drawing objects. */ - const long OBJECTS = 128; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::CellFlags::EDITATTR - /** This value selects formatting within parts of the cell contents. + const long OBJECTS = 128; + + //------------------------------------------------------------------------- + + /** selects formatting within parts of the cell contents. */ - const long EDITATTR = 256; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:45 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + const long EDITATTR = 256; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/CellFormatRanges.idl b/offapi/com/sun/star/sheet/CellFormatRanges.idl index 48204712c..6d338ca4b 100644 --- a/offapi/com/sun/star/sheet/CellFormatRanges.idl +++ b/offapi/com/sun/star/sheet/CellFormatRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellFormatRanges.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:12 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,52 +58,56 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_CellFormatRanges_idl__ -#define __com_sun_star_sheet_CellFormatRanges_idl__ - -#ifndef __com_sun_star_container_XEnumerationAccess_idl__ -#include <com/sun/star/container/XEnumerationAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::CellFormatRanges -/** provides access to ranges with different formatting.@see com::sun::star::sheet::CellFormatRangesEnumeration + +#ifndef __com_sun_star_sheet_CellFormatRanges_idl__ +#define __com_sun_star_sheet_CellFormatRanges_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 + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of equal-formatted cell ranges. + + <p>All cells inside a cell range of this collection have the same + formatting attributes.</p> + + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SheetCellRanges + @see com::sun::star::sheet::UniqueCellFormatRanges */ service CellFormatRanges -{ - // DocMerge: empty anyway - interface com::sun::star::container::XEnumerationAccess; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:45 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:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides methods to access the contained cell ranges by index. + + @see com::sun::star::sheet::SheetCellRange + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all cell ranges. + + @see com::sun::star::sheet::CellFormatRangesEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/CellFormatRangesEnumeration.idl b/offapi/com/sun/star/sheet/CellFormatRangesEnumeration.idl index ac195b3cb..4379d8612 100644 --- a/offapi/com/sun/star/sheet/CellFormatRangesEnumeration.idl +++ b/offapi/com/sun/star/sheet/CellFormatRangesEnumeration.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellFormatRangesEnumeration.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,39 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_CellFormatRangesEnumeration_idl__ -#define __com_sun_star_sheet_CellFormatRangesEnumeration_idl__ - -#ifndef __com_sun_star_container_XEnumeration_idl__ -#include <com/sun/star/container/XEnumeration.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::CellFormatRangesEnumeration -/** enumerates ranges with different formatting. + +#ifndef __com_sun_star_sheet_CellFormatRangesEnumeration_idl__ +#define __com_sun_star_sheet_CellFormatRangesEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of equal-formatted cell ranges. + + @see com::sun::star::sheet::CellFormatRanges */ service CellFormatRangesEnumeration -{ - // DocMerge: empty anyway - interface com::sun::star::container::XEnumeration; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides methods to access the cell ranges in the enumeration. + + @see com::sun::star::sheet::SheetCellRange + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/CellInsertMode.idl b/offapi/com/sun/star/sheet/CellInsertMode.idl index 2015f2dc0..0017de738 100644 --- a/offapi/com/sun/star/sheet/CellInsertMode.idl +++ b/offapi/com/sun/star/sheet/CellInsertMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellInsertMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,75 +58,55 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_CellInsertMode_idl__ -#define __com_sun_star_sheet_CellInsertMode_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::CellInsertMode -/** is used to specify how cells are moved when new cells are - inserted. + +#ifndef __com_sun_star_sheet_CellInsertMode_idl__ +#define __com_sun_star_sheet_CellInsertMode_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** is used to specify how cells are moved when new cells are inserted. */ enum CellInsertMode -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::CellInsertMode::NONE +{ + //------------------------------------------------------------------------- + /** no cells are moved. */ - NONE, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::CellInsertMode::DOWN + NONE, + + //------------------------------------------------------------------------- + /** the cells below the inserted cells are moved down. */ - DOWN, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::CellInsertMode::RIGHT + DOWN, + + //------------------------------------------------------------------------- + /** the cells to the right of the inserted cells are moved right. */ - RIGHT, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::CellInsertMode::ROWS + RIGHT, + + //------------------------------------------------------------------------- + /** entire rows below the inserted cells are moved down. */ - ROWS, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::CellInsertMode::COLUMNS + ROWS, + + //------------------------------------------------------------------------- + /** entire columns to the right of the inserted cells are moved right. */ - COLUMNS - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + COLUMNS + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/Cells.idl b/offapi/com/sun/star/sheet/Cells.idl index f1943fffd..132b0830a 100644 --- a/offapi/com/sun/star/sheet/Cells.idl +++ b/offapi/com/sun/star/sheet/Cells.idl @@ -2,9 +2,9 @@ * * $RCSfile: Cells.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:12 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,52 +58,39 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_Cells_idl__ -#define __com_sun_star_sheet_Cells_idl__ - -#ifndef __com_sun_star_container_XEnumerationAccess_idl__ -#include <com/sun/star/container/XEnumerationAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::Cells -/** provides access to single cells.@see com::sun::star::sheet::CellsEnumeration + +#ifndef __com_sun_star_sheet_Cells_idl__ +#define __com_sun_star_sheet_Cells_idl__ + +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of used cells in a spreadsheet document. + + @see com::sun::star::sheet::SheetCell */ service Cells -{ - // DocMerge: empty anyway - interface com::sun::star::container::XEnumerationAccess; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:45 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:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** creates an enumeration of all used cells. + + @see com::sun::star::sheet::CellsEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/CellsEnumeration.idl b/offapi/com/sun/star/sheet/CellsEnumeration.idl index afd894111..7be87a64b 100644 --- a/offapi/com/sun/star/sheet/CellsEnumeration.idl +++ b/offapi/com/sun/star/sheet/CellsEnumeration.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellsEnumeration.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,39 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_CellsEnumeration_idl__ -#define __com_sun_star_sheet_CellsEnumeration_idl__ - -#ifndef __com_sun_star_container_XEnumeration_idl__ -#include <com/sun/star/container/XEnumeration.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::CellsEnumeration -/** enumerates all cells. + +#ifndef __com_sun_star_sheet_CellsEnumeration_idl__ +#define __com_sun_star_sheet_CellsEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of spreadsheet cells. + + @see com::sun::star::sheet::Cells */ service CellsEnumeration -{ - // DocMerge: empty anyway - interface com::sun::star::container::XEnumeration; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides methods to access the cells in the enumeration. + + @see com::sun::star::sheet::SheetCell + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/ConditionOperator.idl b/offapi/com/sun/star/sheet/ConditionOperator.idl index d4ee08106..35bb1922a 100644 --- a/offapi/com/sun/star/sheet/ConditionOperator.idl +++ b/offapi/com/sun/star/sheet/ConditionOperator.idl @@ -2,9 +2,9 @@ * * $RCSfile: ConditionOperator.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,109 +58,85 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_ConditionOperator_idl__ -#define __com_sun_star_sheet_ConditionOperator_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::ConditionOperator + +#ifndef __com_sun_star_sheet_ConditionOperator_idl__ +#define __com_sun_star_sheet_ConditionOperator_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** is used to specify the type of <type>XSheetCondition</type>. */ enum ConditionOperator -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::NONE +{ + //------------------------------------------------------------------------- + /** no condition is specified. */ - NONE, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::EQUAL + NONE, + + //------------------------------------------------------------------------- + /** value has to be equal to the specified value. */ - EQUAL, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::NOT_EQUAL + EQUAL, + + //------------------------------------------------------------------------- + /** the value must not be equal to the specified value. */ - NOT_EQUAL, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::GREATER + NOT_EQUAL, + + //------------------------------------------------------------------------- + /** the value has to be greater than the specified value. */ - GREATER, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::GREATER_EQUAL + GREATER, + + //------------------------------------------------------------------------- + /** the value has to be greater than or equal to the specified value. */ - GREATER_EQUAL, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::LESS + GREATER_EQUAL, + + //------------------------------------------------------------------------- + /** the value has to be less than the specified value. */ - LESS, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::LESS_EQUAL + LESS, + + //------------------------------------------------------------------------- + /** the value has to be less than or equal to the specified value. */ - LESS_EQUAL, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::BETWEEN + LESS_EQUAL, + + //------------------------------------------------------------------------- + /** the value has to be between the two specified values. */ - BETWEEN, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::NOT_BETWEEN + BETWEEN, + + //------------------------------------------------------------------------- + /** the value has to be outside of the two specified values. */ - NOT_BETWEEN, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::FORMULA + NOT_BETWEEN, + + //------------------------------------------------------------------------- + /** the specified formula has to give a non-zero result. */ - FORMULA - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + FORMULA + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/ConsolidationDescriptor.idl b/offapi/com/sun/star/sheet/ConsolidationDescriptor.idl index 846617015..10124a77f 100644 --- a/offapi/com/sun/star/sheet/ConsolidationDescriptor.idl +++ b/offapi/com/sun/star/sheet/ConsolidationDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: ConsolidationDescriptor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,38 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_ConsolidationDescriptor_idl__ -#define __com_sun_star_sheet_ConsolidationDescriptor_idl__ - -#ifndef __com_sun_star_sheet_XConsolidationDescriptor_idl__ -#include <com/sun/star/sheet/XConsolidationDescriptor.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::ConsolidationDescriptor -/** a description of how data are consolidated. + +#ifndef __com_sun_star_sheet_ConsolidationDescriptor_idl__ +#define __com_sun_star_sheet_ConsolidationDescriptor_idl__ + +#ifndef __com_sun_star_sheet_XConsolidationDescriptor_idl__ +#include <com/sun/star/sheet/XConsolidationDescriptor.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** contains all settings of a data consolidation in a spreadsheet + document. + + @see com::sun::star::sheet::XConsolidatable */ service ConsolidationDescriptor -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XConsolidationDescriptor; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + +/** provides methods to access the settings of the descriptor. + */ + interface com::sun::star::sheet::XConsolidationDescriptor; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DDELink.idl b/offapi/com/sun/star/sheet/DDELink.idl index 3d4e439ca..6722495ba 100644 --- a/offapi/com/sun/star/sheet/DDELink.idl +++ b/offapi/com/sun/star/sheet/DDELink.idl @@ -2,9 +2,9 @@ * * $RCSfile: DDELink.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,60 +58,59 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DDELink_idl__ -#define __com_sun_star_sheet_DDELink_idl__ - -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - -#ifndef __com_sun_star_sheet_XDDELink_idl__ -#include <com/sun/star/sheet/XDDELink.idl> -#endif - -#ifndef __com_sun_star_util_XRefreshable_idl__ -#include <com/sun/star/util/XRefreshable.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DDELink -/** a DDE link. + +#ifndef __com_sun_star_sheet_DDELink_idl__ +#define __com_sun_star_sheet_DDELink_idl__ + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +#ifndef __com_sun_star_sheet_XDDELink_idl__ +#include <com/sun/star/sheet/XDDELink.idl> +#endif + +#ifndef __com_sun_star_util_XRefreshable_idl__ +#include <com/sun/star/util/XRefreshable.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a DDE link. + + <p>A DDE link controls the results of a DDE spreadsheet formula.</p> */ service DDELink -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XDDELink; - - // DocMerge: empty anyway - interface com::sun::star::util::XRefreshable; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access to the name of the DDE link. + + <p>A DDE link has the form <const>Application|Topic!Item</const>.</p> + */ + interface com::sun::star::container::XNamed; + + //------------------------------------------------------------------------- + + /** provides methods to change the settings of the DDE link. + */ + interface com::sun::star::sheet::XDDELink; + + //------------------------------------------------------------------------- + + /** provides methods to reload the external linked data. + */ + interface com::sun::star::util::XRefreshable; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DDELinks.idl b/offapi/com/sun/star/sheet/DDELinks.idl index 47918ae1e..6c1d375b6 100644 --- a/offapi/com/sun/star/sheet/DDELinks.idl +++ b/offapi/com/sun/star/sheet/DDELinks.idl @@ -2,9 +2,9 @@ * * $RCSfile: DDELinks.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,64 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DDELinks_idl__ -#define __com_sun_star_sheet_DDELinks_idl__ - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DDELinks -/** a collection of DDE links. + +#ifndef __com_sun_star_sheet_DDELinks_idl__ +#define __com_sun_star_sheet_DDELinks_idl__ + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of DDE links. + + @see com::sun::star::sheet::DDELink + @see com::sun::star::sheet::SpreadsheetDocument */ service DDELinks -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access to the DDE links via the DDE link string. + + <p>A DDE link has the form <const>Application|Topic!Item</const>.</p> + */ + interface com::sun::star::container::XNameAccess; + + //------------------------------------------------------------------------- + + /** provides access to the DDE links via index. + + @see com::sun::star::sheet::DDELink + + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all DDE links. + + @see com::sun::star::sheet::DDELinksEnumeration + + */ + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DDELinksEnumeration.idl b/offapi/com/sun/star/sheet/DDELinksEnumeration.idl new file mode 100644 index 000000000..c83d89979 --- /dev/null +++ b/offapi/com/sun/star/sheet/DDELinksEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: DDELinksEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:44 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_DDELinksEnumeration_idl__ +#define __com_sun_star_sheet_DDELinksEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of DDE links. + + @see com::sun::star::sheet::DDELink + */ +service DDELinksEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the DDE links in the enumeration. + + @see com::sun::star::sheet::DDELink + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataImportMode.idl b/offapi/com/sun/star/sheet/DataImportMode.idl index 1f6d8a9d5..24784d680 100644 --- a/offapi/com/sun/star/sheet/DataImportMode.idl +++ b/offapi/com/sun/star/sheet/DataImportMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataImportMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,67 +58,49 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataImportMode_idl__ -#define __com_sun_star_sheet_DataImportMode_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::DataImportMode + +#ifndef __com_sun_star_sheet_DataImportMode_idl__ +#define __com_sun_star_sheet_DataImportMode_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** used to specify which database contents are imported. */ enum DataImportMode -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::DataImportMode::NONE +{ + //------------------------------------------------------------------------- + /** nothing is imported. */ - NONE, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::DataImportMode::SQL + NONE, + + //------------------------------------------------------------------------- + /** a SQL query string is supplied. */ - SQL, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::DataImportMode::TABLE + SQL, + + //------------------------------------------------------------------------- + /** the name of a database table is supplied. */ - TABLE, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::DataImportMode::QUERY + TABLE, + + //------------------------------------------------------------------------- + /** the name of a database query is supplied. */ - QUERY - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + QUERY + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotField.idl b/offapi/com/sun/star/sheet/DataPilotField.idl index 5497ec14a..dd96f0a76 100644 --- a/offapi/com/sun/star/sheet/DataPilotField.idl +++ b/offapi/com/sun/star/sheet/DataPilotField.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,82 +58,75 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataPilotField_idl__ -#define __com_sun_star_sheet_DataPilotField_idl__ - -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - -#ifndef __com_sun_star_sheet_DataPilotFieldOrientation_idl__ -#include <com/sun/star/sheet/DataPilotFieldOrientation.idl> -#endif - -#ifndef __com_sun_star_sheet_GeneralFunction_idl__ -#include <com/sun/star/sheet/GeneralFunction.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DataPilotField -/** a single field in a DataPilotDescriptor. + +#ifndef __com_sun_star_sheet_DataPilotField_idl__ +#define __com_sun_star_sheet_DataPilotField_idl__ + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +#ifndef __com_sun_star_sheet_DataPilotFieldOrientation_idl__ +#include <com/sun/star/sheet/DataPilotFieldOrientation.idl> +#endif + +#ifndef __com_sun_star_sheet_GeneralFunction_idl__ +#include <com/sun/star/sheet/GeneralFunction.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a single field in a data pilot table. + + <p>If the data pilot table is based on a spreadsheet cell range, a + field is representred by a column of the range and is named using + the topmost cell of the column.</p> */ service DataPilotField -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; - - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DataPilotField::Orientation - /** this attribute specifies the orientation of the field. +{ + //------------------------------------------------------------------------- + + /** provides access to the name of the data pilot field. */ - [property] com::sun::star::sheet::DataPilotFieldOrientation Orientation; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DataPilotField::Function - /** this attribute specifies the function of the field. - - - + interface com::sun::star::container::XNamed; + + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + //========================================================================= + + /** specifies the orientation of the field. + */ + [property] com::sun::star::sheet::DataPilotFieldOrientation Orientation; + + //------------------------------------------------------------------------- + + /** specifies the function used to calculate results for this field. + <p>For column and row fields, this is the function for subtotals - (<const>GeneralFunction::NONE</const> = no subtotals). - For data fields, this is the function - shown in the data pilot table.</p> + (<const>GeneralFunction::NONE</const> means no subtotals). + For data fields, this is the function shown in the data pilot + table.</p> */ - [property] com::sun::star::sheet::GeneralFunction Function; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [property] com::sun::star::sheet::GeneralFunction Function; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotFieldOrientation.idl b/offapi/com/sun/star/sheet/DataPilotFieldOrientation.idl index 70467e291..31dde0326 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldOrientation.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldOrientation.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotFieldOrientation.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,75 +58,55 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataPilotFieldOrientation_idl__ -#define __com_sun_star_sheet_DataPilotFieldOrientation_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::DataPilotFieldOrientation -/** used to specify where a field in a Data Pilot Table is - laid out. + +#ifndef __com_sun_star_sheet_DataPilotFieldOrientation_idl__ +#define __com_sun_star_sheet_DataPilotFieldOrientation_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to specify where a field in a data pilot table is laid out. */ enum DataPilotFieldOrientation -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::DataPilotFieldOrientation::HIDDEN +{ + //------------------------------------------------------------------------- + /** the field is not used in the table. */ - HIDDEN, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::DataPilotFieldOrientation::COLUMN + HIDDEN, + + //------------------------------------------------------------------------- + /** the field is used as a column field. */ - COLUMN, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::DataPilotFieldOrientation::ROW + COLUMN, + + //------------------------------------------------------------------------- + /** the field is used as a row field. */ - ROW, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::DataPilotFieldOrientation::PAGE + ROW, + + //------------------------------------------------------------------------- + /** the field is used as a page field. */ - PAGE, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::DataPilotFieldOrientation::DATA + PAGE, + + //------------------------------------------------------------------------- + /** the field is used as a data field. */ - DATA - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + DATA + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotFields.idl b/offapi/com/sun/star/sheet/DataPilotFields.idl index de7333979..2d938cd4a 100644 --- a/offapi/com/sun/star/sheet/DataPilotFields.idl +++ b/offapi/com/sun/star/sheet/DataPilotFields.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotFields.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,61 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataPilotFields_idl__ -#define __com_sun_star_sheet_DataPilotFields_idl__ - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DataPilotFields -/** collection of fields in a DataPilotDescriptor. + +#ifndef __com_sun_star_sheet_DataPilotFields_idl__ +#define __com_sun_star_sheet_DataPilotFields_idl__ + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of fields in a data pilot table. + + <p>If the data pilot table is based on a spreadsheet cell range, the + fields are representred by the columns of the range and are named using + the first row of the range.</p> + + @see com::sun::star::sheet::DataPilotTableDescriptor */ service DataPilotFields -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access to the data pilot fields in the collection via index. + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all data pilot fields. + + @see com::sun::star::sheet::DataPilotFieldsEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + + //------------------------------------------------------------------------- + + /** provides access to the data pilot fields in the collection via name. + */ + interface com::sun::star::container::XNameAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotFieldsEnumeration.idl b/offapi/com/sun/star/sheet/DataPilotFieldsEnumeration.idl new file mode 100644 index 000000000..fd2c66d50 --- /dev/null +++ b/offapi/com/sun/star/sheet/DataPilotFieldsEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: DataPilotFieldsEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:45 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_DataPilotFieldsEnumeration_idl__ +#define __com_sun_star_sheet_DataPilotFieldsEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of data pilot fieldss. + + @see com::sun::star::sheet::DataPilotField + */ +service DataPilotFieldsEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the data pilot fields in the enumeration. + + @see com::sun::star::sheet::DataPilotField + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSource.idl b/offapi/com/sun/star/sheet/DataPilotSource.idl index a3b3e2732..e0e163066 100644 --- a/offapi/com/sun/star/sheet/DataPilotSource.idl +++ b/offapi/com/sun/star/sheet/DataPilotSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSource.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,81 +58,83 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataPilotSource_idl__ -#define __com_sun_star_sheet_DataPilotSource_idl__ - -#ifndef __com_sun_star_sheet_XDimensionsSupplier_idl__ -#include <com/sun/star/sheet/XDimensionsSupplier.idl> -#endif - -#ifndef __com_sun_star_sheet_XDataPilotResults_idl__ -#include <com/sun/star/sheet/XDataPilotResults.idl> -#endif - -#ifndef __com_sun_star_util_XRefreshable_idl__ -#include <com/sun/star/util/XRefreshable.idl> -#endif - -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DataPilotSource -/** a data pilot source. + +#ifndef __com_sun_star_sheet_DataPilotSource_idl__ +#define __com_sun_star_sheet_DataPilotSource_idl__ + +#ifndef __com_sun_star_sheet_XDimensionsSupplier_idl__ +#include <com/sun/star/sheet/XDimensionsSupplier.idl> +#endif + +#ifndef __com_sun_star_sheet_XDataPilotResults_idl__ +#include <com/sun/star/sheet/XDataPilotResults.idl> +#endif + +#ifndef __com_sun_star_util_XRefreshable_idl__ +#include <com/sun/star/util/XRefreshable.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a data pilot source. + + <p>A component that implements this service can be used as data source + for a data pilot table in a spreadsheet document.</p> */ service DataPilotSource -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XDimensionsSupplier; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XDataPilotResults; - - // DocMerge: empty anyway - interface com::sun::star::util::XRefreshable; - - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DataPilotSource::ColumnGrand +{ + //------------------------------------------------------------------------- + + /** provides access to the collection of the dimensions of the data + pilot source. + */ + interface com::sun::star::sheet::XDimensionsSupplier; + + //------------------------------------------------------------------------- + + /** gives access to the results of the data pilot table. + */ + interface com::sun::star::sheet::XDataPilotResults; + + //------------------------------------------------------------------------- + + /** provides methods to refresh the data pilot table, that means to + read the data again from the data pilot source. + */ + interface com::sun::star::util::XRefreshable; + + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + //========================================================================= + /** specifies if grand totals for the columns are inserted. */ - [property] boolean ColumnGrand; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DataPilotSource::RowGrand + [property] boolean ColumnGrand; + + //------------------------------------------------------------------------- + /** specifies if grand totals for the rows are inserted. */ - [property] boolean RowGrand; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [property] boolean RowGrand; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceDimension.idl b/offapi/com/sun/star/sheet/DataPilotSourceDimension.idl index 30c2a88b5..3a780ec2f 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceDimension.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceDimension.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceDimension.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-19 13:46:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,143 +58,143 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataPilotSourceDimension_idl__ -#define __com_sun_star_sheet_DataPilotSourceDimension_idl__ - -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - -#ifndef __com_sun_star_sheet_XHierarchiesSupplier_idl__ -#include <com/sun/star/sheet/XHierarchiesSupplier.idl> -#endif - -#ifndef __com_sun_star_util_XCloneable_idl__ -#include <com/sun/star/util/XCloneable.idl> -#endif - -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - -#ifndef __com_sun_star_sheet_DataPilotFieldOrientation_idl__ -#include <com/sun/star/sheet/DataPilotFieldOrientation.idl> -#endif - -#ifndef __com_sun_star_sheet_GeneralFunction_idl__ -#include <com/sun/star/sheet/GeneralFunction.idl> -#endif - -#ifndef __com_sun_star_sheet_TableFilterField_idl__ -#include <com/sun/star/sheet/TableFilterField.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceDimension -/** a dimension in a data pilot source. + +#ifndef __com_sun_star_sheet_DataPilotSourceDimension_idl__ +#define __com_sun_star_sheet_DataPilotSourceDimension_idl__ + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +#ifndef __com_sun_star_sheet_XHierarchiesSupplier_idl__ +#include <com/sun/star/sheet/XHierarchiesSupplier.idl> +#endif + +#ifndef __com_sun_star_util_XCloneable_idl__ +#include <com/sun/star/util/XCloneable.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +#ifndef __com_sun_star_sheet_DataPilotFieldOrientation_idl__ +#include <com/sun/star/sheet/DataPilotFieldOrientation.idl> +#endif + +#ifndef __com_sun_star_sheet_GeneralFunction_idl__ +#include <com/sun/star/sheet/GeneralFunction.idl> +#endif + +#ifndef __com_sun_star_sheet_TableFilterField_idl__ +#include <com/sun/star/sheet/TableFilterField.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a dimension in a data pilot source. + + <p>A dimension is equivalent to a column of a cell range in a spreadsheet + used for a data pilot field.</p> + + <p>In more complex data sources, a dimension may contain several + hierarchies, which consolidate items of a complex data type, called + levels.</p> + + <p>Example: In a database, a column contains date values. This column + will be a dimension of the data pilot source. One hierarchy may contain + the 3 levels year, month, day. Another hierarchy may contain the 2 levels + year and week number.</p> + + @see com::sun::star::sheet::DataPilotSource + @see com::sun::star::sheet::DataPilotTable */ service DataPilotSourceDimension -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XHierarchiesSupplier; - - // DocMerge: empty anyway - interface com::sun::star::util::XCloneable; - - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceDimension::Original - /** returns the dimension from which this dimension was cloned, - or <NULL/> if it was not cloned. +{ + //------------------------------------------------------------------------- + + /** provides access to the name of the dimension, i.e. used in + collections. */ - [readonly, property] com::sun::star::container::XNamed Original; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceDimension::IsDataLayoutDimension + interface com::sun::star::container::XNamed; + + //------------------------------------------------------------------------- + + /** provides access to the collection of hierarchies of this dimension. + */ + interface com::sun::star::sheet::XHierarchiesSupplier; + + //------------------------------------------------------------------------- + + /** supports duplicating the dimension. + + <p>A dimension may be used several times in a data pilot table, + i.e. as row field and data field.</p> + */ + interface com::sun::star::util::XCloneable; + + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + //========================================================================= + + /** returns the name of the dimension from which this dimension was + cloned, or <NULL/> if it was not cloned. + */ + [readonly, property] com::sun::star::container::XNamed Original; + + //------------------------------------------------------------------------- + /** contains <TRUE/> if this is the dimension used to layout the different data dimensions. */ - [readonly, property] boolean IsDataLayoutDimension; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceDimension::Orientation + [readonly, property] boolean IsDataLayoutDimension; + + //------------------------------------------------------------------------- + /** specifies where the dimension is used. */ - [property] com::sun::star::sheet::DataPilotFieldOrientation Orientation; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceDimension::Position + [property] com::sun::star::sheet::DataPilotFieldOrientation Orientation; + + //------------------------------------------------------------------------- + /** specifies the position of the dimension within its orientation. */ - [property] long Position; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceDimension::Function + [property] long Position; + + //------------------------------------------------------------------------- + /** specifies how data are aggregated. */ - [property] com::sun::star::sheet::GeneralFunction Function; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceDimension::UsedHierarchy + [property] com::sun::star::sheet::GeneralFunction Function; + + //------------------------------------------------------------------------- + /** specifies which hierarchy of the dimension is used. + + @see com::sun::star::sheet::DataPilotSourceHierarchies */ - [property] long UsedHierarchy; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR DataPilotSourceDimension::Filter - - // DocMerge from idl: property com::sun::star::sheet::DataPilotSourceDimension::Filter + [property] long UsedHierarchy; + + //------------------------------------------------------------------------- + /** specifies which values are used. */ - [property] sequence<com::sun::star::sheet::TableFilterField> Filter; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:40 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:45 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.5 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:53 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [property] sequence< com::sun::star::sheet::TableFilterField > Filter; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceDimensions.idl b/offapi/com/sun/star/sheet/DataPilotSourceDimensions.idl index 940f81f5f..104a52efe 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceDimensions.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceDimensions.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceDimensions.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,39 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataPilotSourceDimensions_idl__ -#define __com_sun_star_sheet_DataPilotSourceDimensions_idl__ - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceDimensions -/** the collection of dimensions in a data pilot source. + +#ifndef __com_sun_star_sheet_DataPilotSourceDimensions_idl__ +#define __com_sun_star_sheet_DataPilotSourceDimensions_idl__ + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents the collection of dimensions in a data pilot source. + + @see com::sun::star::sheet::DataPilotSource */ service DataPilotSourceDimensions -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access by name to the dimensions in the collection. + + @see com::sun::star::sheet::DataPilotSourceDimension + */ + interface com::sun::star::container::XNameAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceHierarchies.idl b/offapi/com/sun/star/sheet/DataPilotSourceHierarchies.idl index efa3aea57..c41e1adc8 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceHierarchies.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceHierarchies.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceHierarchies.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,52 +58,41 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataPilotSourceHierarchies_idl__ -#define __com_sun_star_sheet_DataPilotSourceHierarchies_idl__ - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceHierarchies -/** the collection of hierarchies in a data pilot source dimension. + +#ifndef __com_sun_star_sheet_DataPilotSourceHierarchies_idl__ +#define __com_sun_star_sheet_DataPilotSourceHierarchies_idl__ + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents the collection of hierarchies in a data pilot source + dimension. + + @see com::sun::star::sheet::DataPilotSourceDimension + @see com::sun::star::sheet::DataPilotSource */ service DataPilotSourceHierarchies -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.4 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.2 2000/03/24 18:01:01 nn - #74032# include-defines - - Revision 1.1 2000/03/24 17:56:47 nn - #74032# Spelling error in file names corrected - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access by name to the hierarchies in the collection. + + @see com::sun::star::sheet::DataPilotSourceHierarchy + */ + interface com::sun::star::container::XNameAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceHierarchy.idl b/offapi/com/sun/star/sheet/DataPilotSourceHierarchy.idl index ccaaf42e2..f49fb805c 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceHierarchy.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceHierarchy.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceHierarchy.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:47 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,59 +58,49 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataPilotSourceHierarchy_idl__ -#define __com_sun_star_sheet_DataPilotSourceHierarchy_idl__ - -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - -#ifndef __com_sun_star_sheet_XLevelsSupplier_idl__ -#include <com/sun/star/sheet/XLevelsSupplier.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceHierarchy -/** a hierarchy in a data pilot source. + +#ifndef __com_sun_star_sheet_DataPilotSourceHierarchy_idl__ +#define __com_sun_star_sheet_DataPilotSourceHierarchy_idl__ + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +#ifndef __com_sun_star_sheet_XLevelsSupplier_idl__ +#include <com/sun/star/sheet/XLevelsSupplier.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a hierarchy in a data pilot source dimension. + + @see com::sun::star::sheet::DataPilotSourceDimension + @see com::sun::star::sheet::DataPilotSource */ service DataPilotSourceHierarchy -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XLevelsSupplier; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.4 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.2 2000/03/24 18:01:01 nn - #74032# include-defines - - Revision 1.1 2000/03/24 17:57:03 nn - #74032# Spelling error in file names corrected - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access to the name of the hierarchy, i.e. used in + collections. + */ + interface com::sun::star::container::XNamed; + + //------------------------------------------------------------------------- + + /** provides access to the collection of levels of this hierarchy. + */ + interface com::sun::star::sheet::XLevelsSupplier; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceLevel.idl b/offapi/com/sun/star/sheet/DataPilotSourceLevel.idl index 7a95b1016..8c27b9f4e 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceLevel.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceLevel.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceLevel.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:47 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,92 +58,87 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataPilotSourceLevel_idl__ -#define __com_sun_star_sheet_DataPilotSourceLevel_idl__ - -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - -#ifndef __com_sun_star_sheet_XMembersSupplier_idl__ -#include <com/sun/star/sheet/XMembersSupplier.idl> -#endif - -#ifndef __com_sun_star_sheet_XDataPilotMemberResults_idl__ -#include <com/sun/star/sheet/XDataPilotMemberResults.idl> -#endif - -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - -#ifndef __com_sun_star_sheet_GeneralFunction_idl__ -#include <com/sun/star/sheet/GeneralFunction.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceLevel -/** a level in a data pilot source. + +#ifndef __com_sun_star_sheet_DataPilotSourceLevel_idl__ +#define __com_sun_star_sheet_DataPilotSourceLevel_idl__ + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +#ifndef __com_sun_star_sheet_XMembersSupplier_idl__ +#include <com/sun/star/sheet/XMembersSupplier.idl> +#endif + +#ifndef __com_sun_star_sheet_XDataPilotMemberResults_idl__ +#include <com/sun/star/sheet/XDataPilotMemberResults.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +#ifndef __com_sun_star_sheet_GeneralFunction_idl__ +#include <com/sun/star/sheet/GeneralFunction.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a level in a data pilot source hierarchy. + + @see com::sun::star::sheet::DataPilotSourceHierarchy + @see com::sun::star::sheet::DataPilotSource */ service DataPilotSourceLevel -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XMembersSupplier; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XDataPilotMemberResults; - - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR DataPilotSourceLevel::SubTotals - - // DocMerge from idl: property com::sun::star::sheet::DataPilotSourceLevel::SubTotals +{ + //------------------------------------------------------------------------- + + /** provides access to the name of the level, i.e. used in collections. + */ + interface com::sun::star::container::XNamed; + + //------------------------------------------------------------------------- + + /** provides access to the collection of members of this level. + */ + interface com::sun::star::sheet::XMembersSupplier; + + //------------------------------------------------------------------------- + + /** provides access to a sequence of results of this level. + */ + interface com::sun::star::sheet::XDataPilotMemberResults; + + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + //========================================================================= + /** specifies the subtotals that are inserted for the level. + + <p>The subtotals are calculated with the members of this level.</p> */ - [property] sequence<com::sun::star::sheet::GeneralFunction> SubTotals; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceLevel::ShowEmpty - /** specifies if empty members are shown. + [property] sequence< com::sun::star::sheet::GeneralFunction > SubTotals; + + //------------------------------------------------------------------------- + + /** specifies whether empty members are shown. */ - [property] boolean ShowEmpty; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.5 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:53 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [property] boolean ShowEmpty; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceLevels.idl b/offapi/com/sun/star/sheet/DataPilotSourceLevels.idl index 93c5dc4b4..faec013fc 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceLevels.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceLevels.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceLevels.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:47 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,40 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataPilotSourceLevels_idl__ -#define __com_sun_star_sheet_DataPilotSourceLevels_idl__ - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceLevels -/** the collection of levels in a data pilot source hierarchy. + +#ifndef __com_sun_star_sheet_DataPilotSourceLevels_idl__ +#define __com_sun_star_sheet_DataPilotSourceLevels_idl__ + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents the collection of levels in a data pilot source hierarchy. + + @see com::sun::star::sheet::DataPilotSourceHierarchy + @see com::sun::star::sheet::DataPilotSource */ service DataPilotSourceLevels -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access by name to the levels in the collection. + + @see com::sun::star::sheet::DataPilotSourceLevel + */ + interface com::sun::star::container::XNameAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceMember.idl b/offapi/com/sun/star/sheet/DataPilotSourceMember.idl index 3b173a132..24ce000a4 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceMember.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceMember.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceMember.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:47 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,67 +58,68 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataPilotSourceMember_idl__ -#define __com_sun_star_sheet_DataPilotSourceMember_idl__ - -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceMember -/** a field in a data pilot source. + +#ifndef __com_sun_star_sheet_DataPilotSourceMember_idl__ +#define __com_sun_star_sheet_DataPilotSourceMember_idl__ + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a member in a data pilot source level. + + <p>Members are the data items that will appear in a data pilot table + as row headers and column headers of the data range (if used in + row or column dimensions), or to calculate the values of the + data range (if used in data dimensions).</p> + + @see com::sun::star::sheet::DataPilotSourceLevel + @see com::sun::star::sheet::DataPilotSource */ service DataPilotSourceMember -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; - - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceMember::IsVisible - /** specifies if the member is visible. +{ + //------------------------------------------------------------------------- + + /** provides access to the name of the member. + + <p>This may be the textual representation of a numerical value.</p> */ - [property] boolean IsVisible; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceMember::ShowDetails - /** specifies if details for the member are shown. + interface com::sun::star::container::XNamed; + + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. */ - [property] boolean ShowDetails; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + interface com::sun::star::beans::XPropertySet; + + //========================================================================= + + /** specifies whether the member is visible. + */ + [property] boolean IsVisible; + + //------------------------------------------------------------------------- + + /** specifies whether details for the member are shown. + */ + [property] boolean ShowDetails; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceMembers.idl b/offapi/com/sun/star/sheet/DataPilotSourceMembers.idl index b80186388..3ccf86a5e 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceMembers.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceMembers.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceMembers.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,40 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataPilotSourceMembers_idl__ -#define __com_sun_star_sheet_DataPilotSourceMembers_idl__ - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceMembers -/** the collection of fields in a data pilot source level. + +#ifndef __com_sun_star_sheet_DataPilotSourceMembers_idl__ +#define __com_sun_star_sheet_DataPilotSourceMembers_idl__ + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents the collection of members in a data pilot source level. + + @see com::sun::star::sheet::DataPilotSourceLevel + @see com::sun::star::sheet::DataPilotSource */ service DataPilotSourceMembers -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access by name to the members in the collection. + + @see com::sun::star::sheet::DataPilotSourceMember + */ + interface com::sun::star::container::XNameAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotTable.idl b/offapi/com/sun/star/sheet/DataPilotTable.idl index 5b4825ade..7923a2ff0 100644 --- a/offapi/com/sun/star/sheet/DataPilotTable.idl +++ b/offapi/com/sun/star/sheet/DataPilotTable.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotTable.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,60 +58,45 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataPilotTable_idl__ -#define __com_sun_star_sheet_DataPilotTable_idl__ - -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - -#ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__ -#include <com/sun/star/sheet/XDataPilotDescriptor.idl> -#endif - -#ifndef __com_sun_star_sheet_XDataPilotTable_idl__ -#include <com/sun/star/sheet/XDataPilotTable.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DataPilotTable -/** a data pilot table on a spreadsheet. + +#ifndef __com_sun_star_sheet_DataPilotTable_idl__ +#define __com_sun_star_sheet_DataPilotTable_idl__ + +#ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__ +#include <com/sun/star/sheet/XDataPilotDescriptor.idl> +#endif + +#ifndef __com_sun_star_sheet_XDataPilotTable_idl__ +#include <com/sun/star/sheet/XDataPilotTable.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a data pilot table on a spreadsheet. */ service DataPilotTable -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XDataPilotDescriptor; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XDataPilotTable; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access to the layout settings of the data pilot table. + */ + interface com::sun::star::sheet::XDataPilotDescriptor; + + //------------------------------------------------------------------------- + + /** provides methods to control a data pilot table. + */ + interface com::sun::star::sheet::XDataPilotTable; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotTables.idl b/offapi/com/sun/star/sheet/DataPilotTables.idl index cb4d6d069..b5e1406a3 100644 --- a/offapi/com/sun/star/sheet/DataPilotTables.idl +++ b/offapi/com/sun/star/sheet/DataPilotTables.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotTables.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,54 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataPilotTables_idl__ -#define __com_sun_star_sheet_DataPilotTables_idl__ - -#ifndef __com_sun_star_sheet_XDataPilotTables_idl__ -#include <com/sun/star/sheet/XDataPilotTables.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DataPilotTables -/** a collection of data pilot tables. + +#ifndef __com_sun_star_sheet_DataPilotTables_idl__ +#define __com_sun_star_sheet_DataPilotTables_idl__ + +#ifndef __com_sun_star_sheet_XDataPilotTables_idl__ +#include <com/sun/star/sheet/XDataPilotTables.idl> +#endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of data pilot tables. */ service DataPilotTables -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XDataPilotTables; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access to the data pilot objects in this collection. + */ + interface com::sun::star::sheet::XDataPilotTables; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all data pilot tables. + + @see com::sun::star::sheet::DataPilotTablesEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + + //------------------------------------------------------------------------- + + /** provides methods to access the contained data pilot tables by index. + + @see com::sun::star::sheet::DataPilotTable + */ + interface com::sun::star::container::XIndexAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotTablesEnumeration.idl b/offapi/com/sun/star/sheet/DataPilotTablesEnumeration.idl new file mode 100644 index 000000000..aec0e94b9 --- /dev/null +++ b/offapi/com/sun/star/sheet/DataPilotTablesEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: DataPilotTablesEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:48 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_DataPilotTablesEnumeration_idl__ +#define __com_sun_star_sheet_DataPilotTablesEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of data pilot tables. + + @see com::sun::star::sheet::DataPilotTable + */ +service DataPilotTablesEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the data pilot tables in the enumeration. + + @see com::sun::star::sheet::DataPilotTable + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataResult.idl b/offapi/com/sun/star/sheet/DataResult.idl index 26771fe04..41fd2e08a 100644 --- a/offapi/com/sun/star/sheet/DataResult.idl +++ b/offapi/com/sun/star/sheet/DataResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataResult.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,51 +58,39 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataResult_idl__ -#define __com_sun_star_sheet_DataResult_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: struct com::sun::star::sheet::DataResult -/** structure describes a result. + +#ifndef __com_sun_star_sheet_DataResult_idl__ +#define __com_sun_star_sheet_DataResult_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** contains the result of one element in the data pilot data array. + + @see com::sun::star::sheet::XDataPilotResults */ struct DataResult { - // DocMerge from xml: field com::sun::star::sheet::DataResult::Flags - /** field contains flags. + /** contains boolean flags describing the result. + + @see com::sun::star::sheet::DataResultFlags */ - long Flags; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::sheet::DataResult::Value - /** field contains the value. + long Flags; + + //------------------------------------------------------------------------- + + /** contains the result value. */ - double Value; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + double Value; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataResultFlags.idl b/offapi/com/sun/star/sheet/DataResultFlags.idl index 4f0d1fdc5..fe285f56c 100644 --- a/offapi/com/sun/star/sheet/DataResultFlags.idl +++ b/offapi/com/sun/star/sheet/DataResultFlags.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataResultFlags.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,61 +58,46 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DataResultFlags_idl__ -#define __com_sun_star_sheet_DataResultFlags_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from idl: constants com::sun::star::sheet::DataResultFlags -/** These constants give information about elements in - data pilot results. + +#ifndef __com_sun_star_sheet_DataResultFlags_idl__ +#define __com_sun_star_sheet_DataResultFlags_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to specify the result type of one element in the data pilot + data array. + + @see com::sun::star::sheet::DataResult */ constants DataResultFlags -{ - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::DataResultFlags::HASDATA +{ + //------------------------------------------------------------------------- + /** The element contains data. */ - const long HASDATA = 1; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::DataResultFlags::SUBTOTAL + const long HASDATA = 1; + + //------------------------------------------------------------------------- + /** The element contains a subtotal. */ - const long SUBTOTAL = 2; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::DataResultFlags::ERROR + const long SUBTOTAL = 2; + + //------------------------------------------------------------------------- + /** The element has an error. */ - const long ERROR = 4; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + const long ERROR = 4; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl b/offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl index c3515e9aa..67aeb36e3 100644 --- a/offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl +++ b/offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseImportDescriptor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,79 +58,54 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DatabaseImportDescriptor_idl__ -#define __com_sun_star_sheet_DatabaseImportDescriptor_idl__ - -#ifndef __com_sun_star_sheet_DataImportMode_idl__ -#include <com/sun/star/sheet/DataImportMode.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DatabaseImportDescriptor -/** a description of how data from an external database is + +#ifndef __com_sun_star_sheet_DatabaseImportDescriptor_idl__ +#define __com_sun_star_sheet_DatabaseImportDescriptor_idl__ + +#ifndef __com_sun_star_sheet_DataImportMode_idl__ +#include <com/sun/star/sheet/DataImportMode.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a description of how data from an external database is imported. + + @see com::sun::star::sheet::XDatabaseRange */ service DatabaseImportDescriptor -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DatabaseImportDescriptor::SourceType - /** this attribute enables importing and specifies from what - type of source data is imported. +{ + //------------------------------------------------------------------------- + + /** enables importing and specifies from what type of source data is + imported. */ - [property] com::sun::star::sheet::DataImportMode SourceType; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DatabaseImportDescriptor::DatabaseName - /** this attribute specifies the name of the database from which - data is imported. + [property] com::sun::star::sheet::DataImportMode SourceType; + + //------------------------------------------------------------------------- + + /** specifies the name of the database from which data is imported. */ - [property] string DatabaseName; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DatabaseImportDescriptor::SourceObject - /** this attribute specifies the table, query, or statement from - which data is imported. - - - + [property] string DatabaseName; + + //------------------------------------------------------------------------- + + /** specifies the table, query, or statement from which data is imported. + <p>The meaning of this is determined by the <member>DatabaseImportDescriptor::SourceType</member> attribute.</p> */ - [property] string SourceObject; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.5 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:07 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:53 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [property] string SourceObject; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DatabaseRange.idl b/offapi/com/sun/star/sheet/DatabaseRange.idl index 79c3ab890..43d9e3cde 100644 --- a/offapi/com/sun/star/sheet/DatabaseRange.idl +++ b/offapi/com/sun/star/sheet/DatabaseRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseRange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,91 +58,92 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DatabaseRange_idl__ -#define __com_sun_star_sheet_DatabaseRange_idl__ - -#ifndef __com_sun_star_sheet_XDatabaseRange_idl__ -#include <com/sun/star/sheet/XDatabaseRange.idl> -#endif - -#ifndef __com_sun_star_sheet_XCellRangeReferrer_idl__ -#include <com/sun/star/sheet/XCellRangeReferrer.idl> -#endif - -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DatabaseRange -/** a database range. + +#ifndef __com_sun_star_sheet_DatabaseRange_idl__ +#define __com_sun_star_sheet_DatabaseRange_idl__ + +#ifndef __com_sun_star_sheet_XDatabaseRange_idl__ +#include <com/sun/star/sheet/XDatabaseRange.idl> +#endif + +#ifndef __com_sun_star_sheet_XCellRangeReferrer_idl__ +#include <com/sun/star/sheet/XCellRangeReferrer.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a database range in a spreadsheet document. + + <p>A database range is a name for a cell range that also stores filtering, + sorting, subtotal and data import settings and options.</p> + + @see com::sun::star::sheet::DatabaseRanges */ service DatabaseRange -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XDatabaseRange; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XCellRangeReferrer; - - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DatabaseRange::MoveCells - /** if this property is set, columns or rows are inserted or deleted - when the size of the range is changed by an update operation. +{ + //------------------------------------------------------------------------- + + /** provides access to the settings of the database range. */ - [property] boolean MoveCells; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DatabaseRange::KeepFormats - /** if this property is set, cell formats are extended - when the size of the range is changed by an update operation. + interface com::sun::star::sheet::XDatabaseRange; + + //------------------------------------------------------------------------- + + /** provides access to the cell range object referred by this named range. */ - [property] boolean KeepFormats; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::DatabaseRange::StripData - /** if this property is set, the cell contents within the database - range are left out when the document is saved. + interface com::sun::star::sheet::XCellRangeReferrer; + + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. */ - [property] boolean StripData; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + interface com::sun::star::beans::XPropertySet; + + //------------------------------------------------------------------------- + + /** provides access to the name of the database range. + */ + interface com::sun::star::container::XNamed; + + //========================================================================= + + /** specifies whether columns or rows are inserted or deleted when the + size of the range is changed by an update operation. + */ + [property] boolean MoveCells; + + //------------------------------------------------------------------------- + + /** specifies whether cell formats are extended when the size of the + range is changed by an update operation. + */ + [property] boolean KeepFormats; + + //------------------------------------------------------------------------- + + /** specifies whether cell contents within the database range are left + out when the document is saved. + */ + [property] boolean StripData; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DatabaseRanges.idl b/offapi/com/sun/star/sheet/DatabaseRanges.idl index a38ec14cc..6cd3923a0 100644 --- a/offapi/com/sun/star/sheet/DatabaseRanges.idl +++ b/offapi/com/sun/star/sheet/DatabaseRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseRanges.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,53 +58,60 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_DatabaseRanges_idl__ -#define __com_sun_star_sheet_DatabaseRanges_idl__ - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - -#ifndef __com_sun_star_sheet_XDatabaseRanges_idl__ -#include <com/sun/star/sheet/XDatabaseRanges.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::DatabaseRanges -/** a collection of database ranges. + +#ifndef __com_sun_star_sheet_DatabaseRanges_idl__ +#define __com_sun_star_sheet_DatabaseRanges_idl__ + +#ifndef __com_sun_star_sheet_XDatabaseRanges_idl__ +#include <com/sun/star/sheet/XDatabaseRanges.idl> +#endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of database ranges in a spreadsheet document. + + @see com::sun::star::sheet::SpreadsheetDocument */ service DatabaseRanges -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XDatabaseRanges; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access to the database ranges and to insert and remove them. + */ + interface com::sun::star::sheet::XDatabaseRanges; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all database ranges. + + @see com::sun::star::sheet::DatabaseRangesEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + + //------------------------------------------------------------------------- + + /** provides access to the database ranges in the collection via index. + + @see com::sun::star::sheet::DatabaseRange + + */ + interface com::sun::star::container::XIndexAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DatabaseRangesEnumeration.idl b/offapi/com/sun/star/sheet/DatabaseRangesEnumeration.idl new file mode 100644 index 000000000..4633a06f3 --- /dev/null +++ b/offapi/com/sun/star/sheet/DatabaseRangesEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: DatabaseRangesEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:50 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_DatabaseRangesEnumeration_idl__ +#define __com_sun_star_sheet_DatabaseRangesEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of database ranges. + + @see com::sun::star::sheet::DatabaseRange + */ +service DatabaseRangesEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the database ranges in the enumeration. + + @see com::sun::star::sheet::DatabaseRange + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/FillDateMode.idl b/offapi/com/sun/star/sheet/FillDateMode.idl index 9d12fb0ce..f2e42a71d 100644 --- a/offapi/com/sun/star/sheet/FillDateMode.idl +++ b/offapi/com/sun/star/sheet/FillDateMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: FillDateMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,69 +58,52 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_FillDateMode_idl__ -#define __com_sun_star_sheet_FillDateMode_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::FillDateMode -/** are used to specify how an arithmetic date series is - calculated. + +#ifndef __com_sun_star_sheet_FillDateMode_idl__ +#define __com_sun_star_sheet_FillDateMode_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to specify how an arithmetic date series is calculated. + + @see com::sun::star::sheet::FillMode */ enum FillDateMode -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FillDateMode::FILL_DATE_DAY +{ + //------------------------------------------------------------------------- + /** for every new value a single day is added. */ - FILL_DATE_DAY, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FillDateMode::FILL_DATE_WEEKDAY - /** for evey new value a single day is added, but Saturdays and Sundays - are skipped. + FILL_DATE_DAY, + + //------------------------------------------------------------------------- + + /** for evey new value a single day is added, but Saturdays and + Sundays are skipped. */ - FILL_DATE_WEEKDAY, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FillDateMode::FILL_DATE_MONTH - /** for every new value one month is added. + FILL_DATE_WEEKDAY, + + //------------------------------------------------------------------------- + + /** for every new value one month is added (day keeps unchanged). */ - FILL_DATE_MONTH, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FillDateMode::FILL_DATE_YEAR - /** for every new value one year is added. + FILL_DATE_MONTH, + + //------------------------------------------------------------------------- + + /** for every new value one year is added (day and month keep unchanged). */ - FILL_DATE_YEAR - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + FILL_DATE_YEAR + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/FillDirection.idl b/offapi/com/sun/star/sheet/FillDirection.idl index 7d015e9d2..782824a46 100644 --- a/offapi/com/sun/star/sheet/FillDirection.idl +++ b/offapi/com/sun/star/sheet/FillDirection.idl @@ -2,9 +2,9 @@ * * $RCSfile: FillDirection.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,71 +58,50 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_FillDirection_idl__ -#define __com_sun_star_sheet_FillDirection_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::FillDirection -/** values are used to specify the direction of filling cells, for example, with - a series. + +#ifndef __com_sun_star_sheet_FillDirection_idl__ +#define __com_sun_star_sheet_FillDirection_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to specify the direction of filling cells, for example, + with a series. */ enum FillDirection -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FillDirection::TO_BOTTOM +{ + //------------------------------------------------------------------------- + /** specifies that rows are filled from top to bottom. */ - TO_BOTTOM, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FillDirection::TO_RIGHT + TO_BOTTOM, + + //------------------------------------------------------------------------- + /** specifies that columns are filled from left to right. */ - TO_RIGHT, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FillDirection::TO_TOP + TO_RIGHT, + + //------------------------------------------------------------------------- + /** specifies that rows are filled from bottom to top. */ - TO_TOP, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FillDirection::TO_LEFT + TO_TOP, + + //------------------------------------------------------------------------- + /** specifies that columns are filled from right to left. */ - TO_LEFT - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + TO_LEFT + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/FillMode.idl b/offapi/com/sun/star/sheet/FillMode.idl index c2a08f570..5df274696 100644 --- a/offapi/com/sun/star/sheet/FillMode.idl +++ b/offapi/com/sun/star/sheet/FillMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: FillMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,100 +58,70 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_FillMode_idl__ -#define __com_sun_star_sheet_FillMode_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::FillMode -/** used to specify the series used to fill cells. + +#ifndef __com_sun_star_sheet_FillMode_idl__ +#define __com_sun_star_sheet_FillMode_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to specify the series type used to fill cells. */ enum FillMode -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FillMode::SIMPLE +{ + //------------------------------------------------------------------------- + /** specifies a constant series. - - - + <p>All cells are filled with the same value.</p> */ - SIMPLE, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FillMode::LINEAR - /** this constant specifies an arithmetic series. - - - + SIMPLE, + + //------------------------------------------------------------------------- + + /** specifies an arithmetic series. + <p>Cell by cell, the value used to fill the cells is increased - by an additive value. - </p> + by an additive value.</p> */ - LINEAR, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FillMode::GROWTH + LINEAR, + + //------------------------------------------------------------------------- + /** specifies a geometric series. - - - + <p>Cell by cell, the value used to fill the cells is multiplied - by a specified value. - </p> + by a specified value.</p> */ - GROWTH, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FillMode::DATE + GROWTH, + + //------------------------------------------------------------------------- + /** specifies an arithmetic series for date values. - - - + <p>Cell by cell, the value used to fill the cells is increased - by a specified number of days. - </p> + by a specified number of days</p> + + @see com::sun::star::sheet::FillDateMode */ - DATE, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FillMode::AUTO + DATE, + + //------------------------------------------------------------------------- + /** specifies the use of a user-defined list. - - - + <p>The cells are filled using a user-defined series.</p> */ - AUTO - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + AUTO + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/FilterConnection.idl b/offapi/com/sun/star/sheet/FilterConnection.idl index ab87fbb05..b5d97ca68 100644 --- a/offapi/com/sun/star/sheet/FilterConnection.idl +++ b/offapi/com/sun/star/sheet/FilterConnection.idl @@ -2,9 +2,9 @@ * * $RCSfile: FilterConnection.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,54 +58,38 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_FilterConnection_idl__ -#define __com_sun_star_sheet_FilterConnection_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::FilterConnection -/** used to specify how two conditions in a filter - descriptor are connected. + +#ifndef __com_sun_star_sheet_FilterConnection_idl__ +#define __com_sun_star_sheet_FilterConnection_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to specify how two conditions in a filter descriptor are + connected. */ enum FilterConnection -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FilterConnection::AND +{ + //------------------------------------------------------------------------- + /** both conditions have to be fulfilled. */ - AND, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FilterConnection::OR + AND, + + //------------------------------------------------------------------------- + /** at least one of the conditions has to be fulfilled. */ - OR - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + OR + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/FilterOperator.idl b/offapi/com/sun/star/sheet/FilterOperator.idl index e6d8d6c66..3d5e965ce 100644 --- a/offapi/com/sun/star/sheet/FilterOperator.idl +++ b/offapi/com/sun/star/sheet/FilterOperator.idl @@ -2,9 +2,9 @@ * * $RCSfile: FilterOperator.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,126 +58,97 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_FilterOperator_idl__ -#define __com_sun_star_sheet_FilterOperator_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::FilterOperator -/** specifies the type of a single condition in a - filter descriptor. + +#ifndef __com_sun_star_sheet_FilterOperator_idl__ +#define __com_sun_star_sheet_FilterOperator_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** specifies the type of a single condition in a filter descriptor. */ enum FilterOperator -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::EMPTY +{ + //------------------------------------------------------------------------- + /** selects empty entries. */ - EMPTY, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::NOT_EMPTY + EMPTY, + + //------------------------------------------------------------------------- + /** selects non-empty entries. */ - NOT_EMPTY, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::EQUAL + NOT_EMPTY, + + //------------------------------------------------------------------------- + /** value has to be equal to the specified value. */ - EQUAL, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::NOT_EQUAL - /** value has to be unequal to the specified value. + EQUAL, + + //------------------------------------------------------------------------- + + /** value must not be equal to the specified value. */ - NOT_EQUAL, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::GREATER + NOT_EQUAL, + + //------------------------------------------------------------------------- + /** value has to be greater than the specified value. */ - GREATER, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::GREATER_EQUAL + GREATER, + + //------------------------------------------------------------------------- + /** value has to be greater than or equal to the specified value. */ - GREATER_EQUAL, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::LESS + GREATER_EQUAL, + + //------------------------------------------------------------------------- + /** value has to be less than the specified value. */ - LESS, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::LESS_EQUAL + LESS, + + //------------------------------------------------------------------------- + /** value has to be less than or equal to the specified value. */ - LESS_EQUAL, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::TOP_VALUES + LESS_EQUAL, + + //------------------------------------------------------------------------- + /** selects a specified number of entries with the greatest values. */ - TOP_VALUES, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::TOP_PERCENT - /** selects a specified percentage of entries with the greatest - values. + TOP_VALUES, + + //------------------------------------------------------------------------- + + /** selects a specified percentage of entries with the greatest values. */ - TOP_PERCENT, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::BOTTOM_VALUES + TOP_PERCENT, + + //------------------------------------------------------------------------- + /** selects a specified number of entries with the lowest values. */ - BOTTOM_VALUES, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::BOTTOM_PERCENT - /** This selects a specified percentage of entries with the lowest - values. + BOTTOM_VALUES, + + //------------------------------------------------------------------------- + + /** selects a specified percentage of entries with the lowest values. */ - BOTTOM_PERCENT - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + BOTTOM_PERCENT + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/FormulaResult.idl b/offapi/com/sun/star/sheet/FormulaResult.idl index 6e20937eb..a649ba99e 100644 --- a/offapi/com/sun/star/sheet/FormulaResult.idl +++ b/offapi/com/sun/star/sheet/FormulaResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: FormulaResult.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,60 +58,43 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_FormulaResult_idl__ -#define __com_sun_star_sheet_FormulaResult_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from idl: constants com::sun::star::sheet::FormulaResult -/** These constants select different result types of cell formulas. + +#ifndef __com_sun_star_sheet_FormulaResult_idl__ +#define __com_sun_star_sheet_FormulaResult_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to select different result types of cell formulas. */ constants FormulaResult -{ - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::FormulaResult::VALUE - /** This selects numeric results. +{ + //------------------------------------------------------------------------- + + /** selects numeric results. */ - const long VALUE = 1; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::FormulaResult::STRING - /** This selects non-numeric results. + const long VALUE = 1; + + //------------------------------------------------------------------------- + + /** selects non-numeric results. */ - const long STRING = 2; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::FormulaResult::ERROR - /** This selects errors. + const long STRING = 2; + + //------------------------------------------------------------------------- + + /** selects errors. */ - const long ERROR = 4; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + const long ERROR = 4; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/FunctionAccess.idl b/offapi/com/sun/star/sheet/FunctionAccess.idl index 2820014ed..f2c8ba143 100644 --- a/offapi/com/sun/star/sheet/FunctionAccess.idl +++ b/offapi/com/sun/star/sheet/FunctionAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: FunctionAccess.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,30 +58,46 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_FunctionAccess_idl__ -#define __com_sun_star_sheet_FunctionAccess_idl__ - -#ifndef __com_sun_star_sheet_XFunctionAccess_idl__ -#include <com/sun/star/sheet/XFunctionAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - + +#ifndef __com_sun_star_sheet_FunctionAccess_idl__ +#define __com_sun_star_sheet_FunctionAccess_idl__ + +#ifndef __com_sun_star_sheet_SpreadsheetDocumentSettings_idl__ +#include <com/sun/star/sheet/SpreadsheetDocumentSettings.idl> +#endif + +#ifndef __com_sun_star_sheet_XFunctionAccess_idl__ +#include <com/sun/star/sheet/XFunctionAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** allows generic access to all spreadsheet functions. */ service FunctionAccess -{ - interface com::sun::star::sheet::XFunctionAccess; -}; - -//============================================================================= - -}; }; }; }; - +{ + //------------------------------------------------------------------------- + + /** contributes properties to control the behaviour of some functions + (i.e. NullDate, IgnoreCase, RegularExpressions). + */ + service com::sun::star::sheet::SpreadsheetDocumentSettings; + + //------------------------------------------------------------------------- + + /** provides calculating the result of a spreadsheet function. + */ + interface com::sun::star::sheet::XFunctionAccess; + +}; + +//============================================================================= + +}; }; }; }; + #endif diff --git a/offapi/com/sun/star/sheet/FunctionArgument.idl b/offapi/com/sun/star/sheet/FunctionArgument.idl index b7af442a4..a1364d769 100644 --- a/offapi/com/sun/star/sheet/FunctionArgument.idl +++ b/offapi/com/sun/star/sheet/FunctionArgument.idl @@ -2,9 +2,9 @@ * * $RCSfile: FunctionArgument.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,65 +58,46 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_FunctionArgument_idl__ -#define __com_sun_star_sheet_FunctionArgument_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: struct com::sun::star::sheet::FunctionArgument -/** contains the description of a single argument within a - <type>FunctionDescription</type>. + +#ifndef __com_sun_star_sheet_FunctionArgument_idl__ +#define __com_sun_star_sheet_FunctionArgument_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** contains the description of a single argument within a spreadsheet + function. + + @see com::sun::star::sheet::FunctionDescription */ struct FunctionArgument { - // DocMerge from xml: field com::sun::star::sheet::FunctionArgument::Name + //------------------------------------------------------------------------- + /** the name of the argument. */ - string Name; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::sheet::FunctionArgument::Description + string Name; + + //------------------------------------------------------------------------- + /** a description of the argument. */ - string Description; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::sheet::FunctionArgument::IsOptional - /** if the argument is optional. + string Description; + + //------------------------------------------------------------------------- + + /** determines whether the argument is optional. */ - boolean IsOptional; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:07 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:53 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + boolean IsOptional; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/FunctionCategory.idl b/offapi/com/sun/star/sheet/FunctionCategory.idl new file mode 100644 index 000000000..cf23f9ceb --- /dev/null +++ b/offapi/com/sun/star/sheet/FunctionCategory.idl @@ -0,0 +1,150 @@ +/************************************************************************* + * + * $RCSfile: FunctionCategory.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:51 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_FunctionCategory_idl__ +#define __com_sun_star_sheet_FunctionCategory_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to specify the category of a spreadsheet function. + */ +constants FunctionCategory +{ + //------------------------------------------------------------------------- + + /** specifies a database function. + */ + const long DATABASE = 1; + + //------------------------------------------------------------------------- + + /** specifies a function that calculates with dates and/or times. + */ + const long DATETIME = 2; + + //------------------------------------------------------------------------- + + /** specifies a financial function. + */ + const long FINANCIAL = 3; + + //------------------------------------------------------------------------- + + /** specifies a function that returns information about the cell, + the cell contents or the current formula. + */ + const long INFORMATION = 4; + + //------------------------------------------------------------------------- + + /** specifies a boolean function. + */ + const long LOGICAL = 5; + + //------------------------------------------------------------------------- + + /** specifies a common mathematical function + */ + const long MATHEMATICAL = 6; + + //------------------------------------------------------------------------- + + /** specifies a matrix function. + */ + const long MATRIX = 7; + + //------------------------------------------------------------------------- + + /** specifies a statistical function + */ + const long STATISTICAL = 8; + + //------------------------------------------------------------------------- + + /** specifies a function that returns information using the spreadsheet + contents or specific cell positions. + */ + const long SPREADSHEET = 9; + + //------------------------------------------------------------------------- + + /** specifies a text function. + */ + const long TEXT = 10; + + //------------------------------------------------------------------------- + + /** specifies a common add-in function. + */ + const long ADDIN = 11; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/FunctionDescription.idl b/offapi/com/sun/star/sheet/FunctionDescription.idl index 603e41cf7..11fa0591b 100644 --- a/offapi/com/sun/star/sheet/FunctionDescription.idl +++ b/offapi/com/sun/star/sheet/FunctionDescription.idl @@ -2,9 +2,9 @@ * * $RCSfile: FunctionDescription.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,88 +58,66 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_FunctionDescription_idl__ -#define __com_sun_star_sheet_FunctionDescription_idl__ - -#ifndef __com_sun_star_sheet_FunctionArgument_idl__ -#include <com/sun/star/sheet/FunctionArgument.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::FunctionDescription -/** a description of a function. + +#ifndef __com_sun_star_sheet_FunctionDescription_idl__ +#define __com_sun_star_sheet_FunctionDescription_idl__ + +#ifndef __com_sun_star_sheet_FunctionArgument_idl__ +#include <com/sun/star/sheet/FunctionArgument.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** collects all properties used to describe a function. + + @see com::sun::star::sheet::FunctionDescriptions */ service FunctionDescription -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::FunctionDescription::Id +{ + //------------------------------------------------------------------------- + /** returns the function's unique identifier. + + @see com::sun::star::sheet::XFunctionDescriptions */ - [readonly, property] long Id; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::FunctionDescription::Category + [readonly, property] long Id; + + //------------------------------------------------------------------------- + /** returns the function's category. + + @see com::sun::star::sheet::FunctionCategory */ - [readonly, property] long Category; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::FunctionDescription::Name - /** returns the function's name. + [readonly, property] long Category; + + //------------------------------------------------------------------------- + + /** returns the localized function's name. */ - [readonly, property] string Name; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::FunctionDescription::Description - /** returns a description of the function. + [readonly, property] string Name; + + //------------------------------------------------------------------------- + + /** returns a localized description of the function. */ - [readonly, property] string Description; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR FunctionDescription::Arguments - - // DocMerge from idl: property com::sun::star::sheet::FunctionDescription::Arguments - /** returns a sequence of descriptions of the function's arguments. + [readonly, property] string Description; + + //------------------------------------------------------------------------- + + /** returns a sequence of localized descriptions of the function's + arguments (in the order specified by the function). */ - [readonly, property] sequence<com::sun::star::sheet::FunctionArgument> Arguments; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.6 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.4 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.3 2000/02/21 16:18:07 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:53 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [readonly, property] sequence< com::sun::star::sheet::FunctionArgument > Arguments; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/FunctionDescriptionEnumeration.idl b/offapi/com/sun/star/sheet/FunctionDescriptionEnumeration.idl new file mode 100644 index 000000000..dc47eee34 --- /dev/null +++ b/offapi/com/sun/star/sheet/FunctionDescriptionEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: FunctionDescriptionEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:52 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_FunctionDescriptionEnumeration_idl__ +#define __com_sun_star_sheet_FunctionDescriptionEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of Function Descriptions. + + @see com::sun::star::sheet::FunctionDescription + */ +service FunctionDescriptionEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the Function Descriptions in the enumeration. + + @see com::sun::star::sheet::FunctionDescription + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/FunctionDescriptions.idl b/offapi/com/sun/star/sheet/FunctionDescriptions.idl index c71ad2cba..971ef20b3 100644 --- a/offapi/com/sun/star/sheet/FunctionDescriptions.idl +++ b/offapi/com/sun/star/sheet/FunctionDescriptions.idl @@ -2,9 +2,9 @@ * * $RCSfile: FunctionDescriptions.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,53 +58,68 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_FunctionDescriptions_idl__ -#define __com_sun_star_sheet_FunctionDescriptions_idl__ - -#ifndef __com_sun_star_sheet_XFunctionDescriptions_idl__ -#include <com/sun/star/sheet/XFunctionDescriptions.idl> -#endif - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::FunctionDescriptions -/** a list of function descriptions. + +#ifndef __com_sun_star_sheet_FunctionDescriptions_idl__ +#define __com_sun_star_sheet_FunctionDescriptions_idl__ + +#ifndef __com_sun_star_sheet_XFunctionDescriptions_idl__ +#include <com/sun/star/sheet/XFunctionDescriptions.idl> +#endif + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of function descriptions for all built-in + functions as well as add-in functions available in the spreadsheet + application. + + <p>All container access methods return a sequence of + <type scope="com::sun::star::beans">PropertyValue</type> structs. + The properties contained in the sequence are collected in the + service <type>FunctionDescription</type>.</p> */ service FunctionDescriptions -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XFunctionDescriptions; - - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access to the property sequence of a function description + via function index or identifier. + */ + interface com::sun::star::sheet::XFunctionDescriptions; + + //------------------------------------------------------------------------- + + /** provides access to the property sequence of a function description + via function name. + + <p>The localized uppercase name of the function has to be used + here.</p> + */ + interface com::sun::star::container::XNameAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all function descriptions. + + @see com::sun::star::sheet::FunctionDescriptionEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/GeneralFunction.idl b/offapi/com/sun/star/sheet/GeneralFunction.idl index e57a79cd1..22c54f3ed 100644 --- a/offapi/com/sun/star/sheet/GeneralFunction.idl +++ b/offapi/com/sun/star/sheet/GeneralFunction.idl @@ -2,9 +2,9 @@ * * $RCSfile: GeneralFunction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,130 +58,105 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_GeneralFunction_idl__ -#define __com_sun_star_sheet_GeneralFunction_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::GeneralFunction + +#ifndef __com_sun_star_sheet_GeneralFunction_idl__ +#define __com_sun_star_sheet_GeneralFunction_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** used to specify a function to be calculated from values. */ enum GeneralFunction -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::NONE +{ + //------------------------------------------------------------------------- + /** nothing is calculated. */ - NONE, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::AUTO + NONE, + + //------------------------------------------------------------------------- + /** function is determined automatically. + + <p>If the values are all numerical, SUM is used, otherwise COUNT.</p> */ - AUTO, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::SUM + AUTO, + + //------------------------------------------------------------------------- + /** sum of all numerical values is calculated. */ - SUM, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::COUNT + SUM, + + //------------------------------------------------------------------------- + /** all values, including non-numerical values, are counted. */ - COUNT, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::AVERAGE + COUNT, + + //------------------------------------------------------------------------- + /** average of all numerical values is calculated. */ - AVERAGE, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::MAX + AVERAGE, + + //------------------------------------------------------------------------- + /** maximum value of all numerical values is calculated. */ - MAX, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::MIN + MAX, + + //------------------------------------------------------------------------- + /** minimum value of all numerical values is calculated. */ - MIN, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::PRODUCT + MIN, + + //------------------------------------------------------------------------- + /** product of all numerical values is calculated. */ - PRODUCT, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::COUNTNUMS + PRODUCT, + + //------------------------------------------------------------------------- + /** numerical values are counted. */ - COUNTNUMS, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::STDEV + COUNTNUMS, + + //------------------------------------------------------------------------- + /** standard deviation is calculated based on a sample. */ - STDEV, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::STDEVP + STDEV, + + //------------------------------------------------------------------------- + /** standard deviation is calculated based on the entire population. */ - STDEVP, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::VAR + STDEVP, + + //------------------------------------------------------------------------- + /** variance is calculated based on a sample. */ - VAR, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::VARP + VAR, + + //------------------------------------------------------------------------- + /** variance is calculated based on the entire population. */ - VARP - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + VARP + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/GlobalSheetSettings.idl b/offapi/com/sun/star/sheet/GlobalSheetSettings.idl index 185819dc2..ab7b47144 100644 --- a/offapi/com/sun/star/sheet/GlobalSheetSettings.idl +++ b/offapi/com/sun/star/sheet/GlobalSheetSettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: GlobalSheetSettings.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,157 +58,169 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_GlobalSheetSettings_idl__ -#define __com_sun_star_sheet_GlobalSheetSettings_idl__ - -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::GlobalSheetSettings -/** the settings for all spreadsheets. + +#ifndef __com_sun_star_sheet_GlobalSheetSettings_idl__ +#define __com_sun_star_sheet_GlobalSheetSettings_idl__ + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** contributes properties to access the settings for all spreadsheets of + a spreadsheet document. */ service GlobalSheetSettings -{ - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::MoveSelection - /** if this property is set, the cursor is moved after entering into - cells. - */ - [property] boolean MoveSelection; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::MoveDirection - /** contains the direction the cursor is moved after - entering cells. - */ - [property] short MoveDirection; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::EnterEdit - /** if this property is set, the enter key can be used to start editing - a cell. - */ - [property] boolean EnterEdit; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::ExtendFormat - /** if this property is set, cell formatting is extended when entering - data. - */ - [property] boolean ExtendFormat; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::RangeFinder - /** if this property is set, ranges are highlighted on the sheet when +{ + //------------------------------------------------------------------------- + +//! service com::sun::star::beans::PropertySet; + /** provides access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + //========================================================================= + + /** specifies whether the cursor is moved after entering into cells. + */ + [property] boolean MoveSelection; + + //------------------------------------------------------------------------- + + /** contains the direction the cursor moves after entering cells. + + @see com::sun::star::sheet::MoveDirection + */ + [property] short MoveDirection; + + //------------------------------------------------------------------------- + + /** specifies whether the enter key can be used to start editing a cell. + */ + [property] boolean EnterEdit; + + //------------------------------------------------------------------------- + + /** specifies whether cell formatting is extended when entering data. + */ + [property] boolean ExtendFormat; + + //------------------------------------------------------------------------- + + /** specifies whether ranges are highlighted on the sheet when editing a formula. */ - [property] boolean RangeFinder; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::ExpandReferences - /** if this property is set, formula references are extended when cells + [property] boolean RangeFinder; + + //------------------------------------------------------------------------- + + /** specifies whether formula references are extended when cells are inserted below or to the right of them. */ - [property] boolean ExpandReferences; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::MarkHeader - /** if this property is set, the current selection is highlighted in + [property] boolean ExpandReferences; + + //------------------------------------------------------------------------- + + /** specifies whether the current selection is highlighted in column and row headers. */ - [property] boolean MarkHeader; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::UseTabCol - /** if this property is set, the enter key moves the cursor to the - column it was in before using the tab key to change columns. - */ - [property] boolean UseTabCol; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::Metric + [property] boolean MarkHeader; + + //------------------------------------------------------------------------- + + /** specifies whether the enter key moves the cursor to the column + it was in before using the tab key to change columns. + */ + [property] boolean UseTabCol; + + //------------------------------------------------------------------------- + /** contains the metric for all spreadsheet documents. + + @see com::sun::star::util::MeasureUnit + */ + [property] short Metric; + + //------------------------------------------------------------------------- + + /** contains the default scale for new spreadsheet documents + (in percent). + + <p>There are several special values:</p> + <p>-1 = Optimal width</p> + <p>-2 = Show whole page</p> + <p>-3 = Page width</p> + */ + [property] short Scale; + + //------------------------------------------------------------------------- + + /** specifies whether automatic completion of text in a cell is used. + */ + [property] boolean DoAutoComplete; + + //------------------------------------------------------------------------- + + /** contains the function that is displayed in the status bar. + + @see com::sun::star::sheet::StatusBarFunction + */ + [property] short StatusBarFunction; + + //------------------------------------------------------------------------- + + /** contains the string lists used for sorting and filling. + + <p>Each string contains the members of a list, separated by + commas.</p> + */ + [property] sequence< string > UserLists; + + //------------------------------------------------------------------------- + + /** specifies the update mode for external linked data. + + <p>0 = always</p> + <p>1 = never</p> + <p>2 = on demand</p> + */ + [optional, property] short LinkUpdateMode; + + //------------------------------------------------------------------------- + + /** specifies whether all sheets or only selected sheets are printed. + */ + [optional, property] boolean PrintAllSheets; + + //------------------------------------------------------------------------- + + /** specifies whether empty pages are printed. + */ + [optional, property] boolean PrintEmptyPages; + + //------------------------------------------------------------------------- + + /** specifies whether printer metrics are used for display. + */ + [optional, property] boolean UsePrinterMetrics; + + //------------------------------------------------------------------------- + + /** specifies whether a warning is shown before replacing cells + (i.e. when pasting from clipboard). */ - [property] short Metric; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::Scale - /** contains the default scale for new spreadsheet - documents. - */ - [property] short Scale; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::DoAutoComplete - /** enables automatic completion of text in a cell. - */ - [property] boolean DoAutoComplete; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::StatusBarFunction - /** contains the function that is displayed in the - status bar. - */ - [property] short StatusBarFunction; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR GlobalSheetSettings::UserLists - - // DocMerge from idl: property com::sun::star::sheet::GlobalSheetSettings::UserLists - /** contains the string lists used for sorting and - filling. - <P>Each string contains the members of a list, separated by - commas.</P> - */ - [property] sequence<string> UserLists; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [optional, property] boolean ReplaceCellsWarning; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/GoalResult.idl b/offapi/com/sun/star/sheet/GoalResult.idl index 5680bf1cb..aeb8c4c2f 100644 --- a/offapi/com/sun/star/sheet/GoalResult.idl +++ b/offapi/com/sun/star/sheet/GoalResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: GoalResult.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,51 +58,35 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_GoalResult_idl__ -#define __com_sun_star_sheet_GoalResult_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: struct com::sun::star::sheet::GoalResult + +#ifndef __com_sun_star_sheet_GoalResult_idl__ +#define __com_sun_star_sheet_GoalResult_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** is the result of a goal seek operation. */ struct GoalResult { - // DocMerge from xml: field com::sun::star::sheet::GoalResult::Divergence /** the amount by which the result changed in the last iteration. */ - double Divergence; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::sheet::GoalResult::Result + double Divergence; + + //------------------------------------------------------------------------- + /** the resulting value. */ - double Result; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + double Result; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/HeaderFooterContent.idl b/offapi/com/sun/star/sheet/HeaderFooterContent.idl index 654e8e7d2..d62710256 100644 --- a/offapi/com/sun/star/sheet/HeaderFooterContent.idl +++ b/offapi/com/sun/star/sheet/HeaderFooterContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: HeaderFooterContent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,37 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_HeaderFooterContent_idl__ -#define __com_sun_star_sheet_HeaderFooterContent_idl__ - -#ifndef __com_sun_star_sheet_XHeaderFooterContent_idl__ -#include <com/sun/star/sheet/XHeaderFooterContent.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::HeaderFooterContent -/** the content of a header or footer in a page format. + +#ifndef __com_sun_star_sheet_HeaderFooterContent_idl__ +#define __com_sun_star_sheet_HeaderFooterContent_idl__ + +#ifndef __com_sun_star_sheet_XHeaderFooterContent_idl__ +#include <com/sun/star/sheet/XHeaderFooterContent.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents the contents of a header or footer line in a page style. + + @see com::sun::star::sheet::TablePageStyle */ service HeaderFooterContent -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XHeaderFooterContent; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access to the text parts of the header or footer line. + */ + interface com::sun::star::sheet::XHeaderFooterContent; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/LabelRange.idl b/offapi/com/sun/star/sheet/LabelRange.idl index f9542d29b..00de44498 100644 --- a/offapi/com/sun/star/sheet/LabelRange.idl +++ b/offapi/com/sun/star/sheet/LabelRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: LabelRange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,38 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_LabelRange_idl__ -#define __com_sun_star_sheet_LabelRange_idl__ - -#ifndef __com_sun_star_sheet_XLabelRange_idl__ -#include <com/sun/star/sheet/XLabelRange.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::LabelRange -/** a label range. + +#ifndef __com_sun_star_sheet_LabelRange_idl__ +#define __com_sun_star_sheet_LabelRange_idl__ + +#ifndef __com_sun_star_sheet_XLabelRange_idl__ +#include <com/sun/star/sheet/XLabelRange.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a cell area that contains labels and values related to the + labels. + + <p>Label ranges can be used in formulas to refer to cells in cell + ranges with row or column titles. The formula uses the cell value that + is related to the specified row or column title.</p> */ service LabelRange -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XLabelRange; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + /** provides access to the settings of a label range. + */ + interface com::sun::star::sheet::XLabelRange; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/LabelRanges.idl b/offapi/com/sun/star/sheet/LabelRanges.idl index b53d7dc69..2ce134a06 100644 --- a/offapi/com/sun/star/sheet/LabelRanges.idl +++ b/offapi/com/sun/star/sheet/LabelRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: LabelRanges.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,53 +58,64 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_LabelRanges_idl__ -#define __com_sun_star_sheet_LabelRanges_idl__ - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> -#endif - -#ifndef __com_sun_star_sheet_XLabelRanges_idl__ -#include <com/sun/star/sheet/XLabelRanges.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::LabelRanges -/** a collection of label ranges. + +#ifndef __com_sun_star_sheet_LabelRanges_idl__ +#define __com_sun_star_sheet_LabelRanges_idl__ + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +#ifndef __com_sun_star_sheet_XLabelRanges_idl__ +#include <com/sun/star/sheet/XLabelRanges.idl> +#endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of label ranges in a spreadsheet document. + + @see com::sun::star::sheet::LabelRange + @see com::sun::star::sheet::SpreadsheetDocument */ service LabelRanges -{ - // DocMerge: empty anyway - interface com::sun::star::container::XIndexAccess; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XLabelRanges; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides methods to access the members of the label range collection + and to insert and remove them. + */ + interface com::sun::star::sheet::XLabelRanges; + + //------------------------------------------------------------------------- + + /** provides access to the label ranges via index. + + @see com::sun::star::sheet::LabelRange + + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all label ranges. + + @see com::sun::star::sheet::LabelRangesEnumeration + + */ + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/LabelRangesEnumeration.idl b/offapi/com/sun/star/sheet/LabelRangesEnumeration.idl new file mode 100644 index 000000000..07f8b864b --- /dev/null +++ b/offapi/com/sun/star/sheet/LabelRangesEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: LabelRangesEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:54 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_LabelRangesEnumeration_idl__ +#define __com_sun_star_sheet_LabelRangesEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of label ranges. + + @see com::sun::star::sheet::LabelRange + */ +service LabelRangesEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the label ranges in the enumeration. + + @see com::sun::star::sheet::LabelRange + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/LocalizedName.idl b/offapi/com/sun/star/sheet/LocalizedName.idl index 31fcbd874..7775638db 100644 --- a/offapi/com/sun/star/sheet/LocalizedName.idl +++ b/offapi/com/sun/star/sheet/LocalizedName.idl @@ -2,9 +2,9 @@ * * $RCSfile: LocalizedName.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: nn $ $Date: 2001-02-19 19:52:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,34 +58,42 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_LocalizedName_idl__ -#define __com_sun_star_sheet_LocalizedName_idl__ - -#ifndef __com_sun_star_lang_Locale_idl__ -#include <com/sun/star/lang/Locale.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= + +#ifndef __com_sun_star_sheet_LocalizedName_idl__ +#define __com_sun_star_sheet_LocalizedName_idl__ + +#ifndef __com_sun_star_lang_Locale_idl__ +#include <com/sun/star/lang/Locale.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= /** A name that is valid for a specified locale. + + @see com::sun::star::sheet::XCompatibilityNames */ struct LocalizedName { - /// The locale for which this name is valid. + // ------------------------------------------------------------------------ + + /** The locale for which this name is valid. + */ ::com::sun::star::lang::Locale Locale; - /// The name itself. + // ------------------------------------------------------------------------ + + /** The name itself. + */ string Name; }; - -//============================================================================= - -}; }; }; }; - + +//============================================================================= + +}; }; }; }; + #endif diff --git a/offapi/com/sun/star/sheet/MemberResult.idl b/offapi/com/sun/star/sheet/MemberResult.idl index a954d34bc..13fef0d20 100644 --- a/offapi/com/sun/star/sheet/MemberResult.idl +++ b/offapi/com/sun/star/sheet/MemberResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: MemberResult.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,64 +58,45 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_MemberResult_idl__ -#define __com_sun_star_sheet_MemberResult_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: struct com::sun::star::sheet::MemberResult -/** describes a result. + +#ifndef __com_sun_star_sheet_MemberResult_idl__ +#define __com_sun_star_sheet_MemberResult_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** describes a result of a DataPilot member. + + @see com::sun::star::sheet::XDataPilotMemberResults */ struct MemberResult { - // DocMerge from xml: field com::sun::star::sheet::MemberResult::Name /** the internal name of the field. */ - string Name; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::sheet::MemberResult::Caption + string Name; + + //------------------------------------------------------------------------- + /** the visible name of the field. */ - string Caption; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::sheet::MemberResult::Flags - /** field contains flags. + string Caption; + + //------------------------------------------------------------------------- + + /** contains flags describing the result. + + @see com::sun::star::sheet::MemberResultFlags */ - long Flags; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:08 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + long Flags; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/MemberResultFlags.idl b/offapi/com/sun/star/sheet/MemberResultFlags.idl index a33373320..6e4d2e3ab 100644 --- a/offapi/com/sun/star/sheet/MemberResultFlags.idl +++ b/offapi/com/sun/star/sheet/MemberResultFlags.idl @@ -2,9 +2,9 @@ * * $RCSfile: MemberResultFlags.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,61 +58,43 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_MemberResultFlags_idl__ -#define __com_sun_star_sheet_MemberResultFlags_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from idl: constants com::sun::star::sheet::MemberResultFlags -/** These constants give information about elements in - data pilot member results. + +#ifndef __com_sun_star_sheet_MemberResultFlags_idl__ +#define __com_sun_star_sheet_MemberResultFlags_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to give information about elements in data pilot member results. */ constants MemberResultFlags -{ - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::MemberResultFlags::HASMEMBER +{ + //------------------------------------------------------------------------- + /** The element contains a member. */ - const long HASMEMBER = 1; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::MemberResultFlags::SUBTOTAL + const long HASMEMBER = 1; + + //------------------------------------------------------------------------- + /** The element contains a subtotal. */ - const long SUBTOTAL = 2; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::MemberResultFlags::CONTINUE + const long SUBTOTAL = 2; + + //------------------------------------------------------------------------- + /** The element is a continuation of the previous one. */ - const long CONTINUE = 4; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + const long CONTINUE = 4; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/MoveDirection.idl b/offapi/com/sun/star/sheet/MoveDirection.idl new file mode 100644 index 000000000..79e69bac8 --- /dev/null +++ b/offapi/com/sun/star/sheet/MoveDirection.idl @@ -0,0 +1,107 @@ +/************************************************************************* + * + * $RCSfile: MoveDirection.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:55 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_MoveDirection_idl__ +#define __com_sun_star_sheet_MoveDirection_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to specify the direction of moving the current selection i.e. + after a cell has been left with Enter. + */ +constants MoveDirection +{ + //------------------------------------------------------------------------- + + /** specifies that the selection moves one cell down. + */ + const short DOWN = 0; + + //------------------------------------------------------------------------- + + /** specifies that the selection moves one cell right. + */ + const short RIGHT = 1; + + //------------------------------------------------------------------------- + + /** specifies that the selection moves one cell up. + */ + const short UP = 2; + + //------------------------------------------------------------------------- + + /** specifies that the selection moves one cell left. + */ + const short LEFT = 3; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/NamedRange.idl b/offapi/com/sun/star/sheet/NamedRange.idl index ffa74a9ca..68491a076 100644 --- a/offapi/com/sun/star/sheet/NamedRange.idl +++ b/offapi/com/sun/star/sheet/NamedRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: NamedRange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,60 +58,57 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_NamedRange_idl__ -#define __com_sun_star_sheet_NamedRange_idl__ - -#ifndef __com_sun_star_sheet_XNamedRange_idl__ -#include <com/sun/star/sheet/XNamedRange.idl> -#endif - -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - -#ifndef __com_sun_star_sheet_XCellRangeReferrer_idl__ -#include <com/sun/star/sheet/XCellRangeReferrer.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::NamedRange -/** a range which can be addressed by a name. + +#ifndef __com_sun_star_sheet_NamedRange_idl__ +#define __com_sun_star_sheet_NamedRange_idl__ + +#ifndef __com_sun_star_sheet_XNamedRange_idl__ +#include <com/sun/star/sheet/XNamedRange.idl> +#endif + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +#ifndef __com_sun_star_sheet_XCellRangeReferrer_idl__ +#include <com/sun/star/sheet/XCellRangeReferrer.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a named range in a spreadsheet document. + + <p>In fact a named range is a named formula expression. A cell range + address is one possible content of a named range.</p> + + @see com::sun::star::sheet::NamedRanges */ service NamedRange -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XNamedRange; - - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XCellRangeReferrer; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access to the settings of the named range. + */ + interface com::sun::star::sheet::XNamedRange; + + //------------------------------------------------------------------------- + + /** provides access to the cell range object referred by this named range. + + <p>This works only, if the named range contains a single cell range + address.</p> + */ + interface com::sun::star::sheet::XCellRangeReferrer; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/NamedRangeFlag.idl b/offapi/com/sun/star/sheet/NamedRangeFlag.idl index 537595f54..da133f819 100644 --- a/offapi/com/sun/star/sheet/NamedRangeFlag.idl +++ b/offapi/com/sun/star/sheet/NamedRangeFlag.idl @@ -2,9 +2,9 @@ * * $RCSfile: NamedRangeFlag.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,67 +58,49 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_NamedRangeFlag_idl__ -#define __com_sun_star_sheet_NamedRangeFlag_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from idl: constants com::sun::star::sheet::NamedRangeFlag -/** These constants are used to specify the purpose of a named range. + +#ifndef __com_sun_star_sheet_NamedRangeFlag_idl__ +#define __com_sun_star_sheet_NamedRangeFlag_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to specify the purpose of a named range. */ constants NamedRangeFlag -{ - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::NamedRangeFlag::FILTER_CRITERIA +{ + //------------------------------------------------------------------------- + /** The range contains filter criteria. */ - const long FILTER_CRITERIA = 1; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::NamedRangeFlag::PRINT_AREA + const long FILTER_CRITERIA = 1; + + //------------------------------------------------------------------------- + /** The range can be used as a print range. */ - const long PRINT_AREA = 2; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::NamedRangeFlag::COLUMN_HEADER + const long PRINT_AREA = 2; + + //------------------------------------------------------------------------- + /** The range can be used as column headers for printing. */ - const long COLUMN_HEADER = 4; - - //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::sheet::NamedRangeFlag::ROW_HEADER + const long COLUMN_HEADER = 4; + + //------------------------------------------------------------------------- + /** The range can be used as row headers for printing. */ - const long ROW_HEADER = 8; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + const long ROW_HEADER = 8; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/NamedRanges.idl b/offapi/com/sun/star/sheet/NamedRanges.idl index 6650aeddc..c8fbb8884 100644 --- a/offapi/com/sun/star/sheet/NamedRanges.idl +++ b/offapi/com/sun/star/sheet/NamedRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: NamedRanges.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,53 +58,68 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_NamedRanges_idl__ -#define __com_sun_star_sheet_NamedRanges_idl__ - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - -#ifndef __com_sun_star_sheet_XNamedRanges_idl__ -#include <com/sun/star/sheet/XNamedRanges.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::NamedRanges -/** a collection of named ranges. + +#ifndef __com_sun_star_sheet_NamedRanges_idl__ +#define __com_sun_star_sheet_NamedRanges_idl__ + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif + +#ifndef __com_sun_star_sheet_XNamedRanges_idl__ +#include <com/sun/star/sheet/XNamedRanges.idl> +#endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of named ranges in a spreadsheet document. + + <p>In fact a named range is a named formula expression. A cell range + address is one possible content of a named range.</p> + + @see com::sun::star::sheet::SpreadsheetDocument */ service NamedRanges -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XNamedRanges; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access to the named ranges and to insert and remove them. + */ + interface com::sun::star::sheet::XNamedRanges; + + //------------------------------------------------------------------------- + + /** provides access to the named ranges via index. + + @see com::sun::star::sheet::NamedRange + + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all named ranges. + + @see com::sun::star::sheet::NamedRangesEnumeration + + */ + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/NamedRangesEnumeration.idl b/offapi/com/sun/star/sheet/NamedRangesEnumeration.idl new file mode 100644 index 000000000..48de73b05 --- /dev/null +++ b/offapi/com/sun/star/sheet/NamedRangesEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: NamedRangesEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:56 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_NamedRangesEnumeration_idl__ +#define __com_sun_star_sheet_NamedRangesEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of named ranges. + + @see com::sun::star::sheet::NamedRange + */ +service NamedRangesEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the named ranges in the enumeration. + + @see com::sun::star::sheet::NamedRange + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/PasteOperation.idl b/offapi/com/sun/star/sheet/PasteOperation.idl index 2d3729f61..70a9fc94c 100644 --- a/offapi/com/sun/star/sheet/PasteOperation.idl +++ b/offapi/com/sun/star/sheet/PasteOperation.idl @@ -2,9 +2,9 @@ * * $RCSfile: PasteOperation.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,75 +58,56 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_PasteOperation_idl__ -#define __com_sun_star_sheet_PasteOperation_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::PasteOperation -/** used to specify which operations are carried out when - pasting cell values into a cell range. + +#ifndef __com_sun_star_sheet_PasteOperation_idl__ +#define __com_sun_star_sheet_PasteOperation_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to specify which operations are carried out when pasting cell + values into a cell range. */ enum PasteOperation -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::PasteOperation::NONE +{ + //------------------------------------------------------------------------- + /** new values are used without changes. */ - NONE, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::PasteOperation::ADD + NONE, + + //------------------------------------------------------------------------- + /** old and new values are added. */ - ADD, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::PasteOperation::SUBTRACT + ADD, + + //------------------------------------------------------------------------- + /** new values are subtracted from the old values. */ - SUBTRACT, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::PasteOperation::MULTIPLY + SUBTRACT, + + //------------------------------------------------------------------------- + /** old and new values are multiplied. */ - MULTIPLY, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::PasteOperation::DIVIDE + MULTIPLY, + + //------------------------------------------------------------------------- + /** new values are divided by the new values. */ - DIVIDE - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + DIVIDE + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/RangeSelectionArguments.idl b/offapi/com/sun/star/sheet/RangeSelectionArguments.idl index 7474afc8c..1b322e05c 100644 --- a/offapi/com/sun/star/sheet/RangeSelectionArguments.idl +++ b/offapi/com/sun/star/sheet/RangeSelectionArguments.idl @@ -2,9 +2,9 @@ * * $RCSfile: RangeSelectionArguments.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,6 +68,8 @@ //============================================================================= /** contains the arguments for starting the range selection. + + @see com::sun::star::sheet::XRangeSelection */ service RangeSelectionArguments { diff --git a/offapi/com/sun/star/sheet/RangeSelectionEvent.idl b/offapi/com/sun/star/sheet/RangeSelectionEvent.idl index c0b444df8..dbce70828 100644 --- a/offapi/com/sun/star/sheet/RangeSelectionEvent.idl +++ b/offapi/com/sun/star/sheet/RangeSelectionEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: RangeSelectionEvent.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: nn $ $Date: 2000-11-09 19:50:08 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,6 +72,9 @@ //============================================================================= /** specifies an event from range selection. + + @see com::sun::star::sheet::XRangeSelectionListener + @see com::sun::star::sheet::XRangeSelectionChangeListener */ struct RangeSelectionEvent: com::sun::star::lang::EventObject { diff --git a/offapi/com/sun/star/sheet/RecentFunctions.idl b/offapi/com/sun/star/sheet/RecentFunctions.idl index 91f5c198d..75561a266 100644 --- a/offapi/com/sun/star/sheet/RecentFunctions.idl +++ b/offapi/com/sun/star/sheet/RecentFunctions.idl @@ -2,9 +2,9 @@ * * $RCSfile: RecentFunctions.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,35 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_RecentFunctions_idl__ -#define __com_sun_star_sheet_RecentFunctions_idl__ - -#ifndef __com_sun_star_sheet_XRecentFunctions_idl__ -#include <com/sun/star/sheet/XRecentFunctions.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::RecentFunctions -/** the list of recently used functions. + +#ifndef __com_sun_star_sheet_RecentFunctions_idl__ +#define __com_sun_star_sheet_RecentFunctions_idl__ + +#ifndef __com_sun_star_sheet_XRecentFunctions_idl__ +#include <com/sun/star/sheet/XRecentFunctions.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** contains the list of recently used spreadsheet functions. */ service RecentFunctions -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XRecentFunctions; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access to the list of recently used spreadsheet functions. + */ + interface com::sun::star::sheet::XRecentFunctions; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/ResultEvent.idl b/offapi/com/sun/star/sheet/ResultEvent.idl index b9f9d73f4..27d42a515 100644 --- a/offapi/com/sun/star/sheet/ResultEvent.idl +++ b/offapi/com/sun/star/sheet/ResultEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ResultEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,55 +58,40 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_ResultEvent_idl__ -#define __com_sun_star_sheet_ResultEvent_idl__ - -#ifndef __com_sun_star_lang_EventObject_idl__ -#include <com/sun/star/lang/EventObject.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: struct com::sun::star::sheet::ResultEvent -/** contains the new value of a volatile result. + +#ifndef __com_sun_star_sheet_ResultEvent_idl__ +#define __com_sun_star_sheet_ResultEvent_idl__ + +#ifndef __com_sun_star_lang_EventObject_idl__ +#include <com/sun/star/lang/EventObject.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** contains the new value of a volatile function result. + + @see com::sun::star::sheet::XVolatileResult */ struct ResultEvent: com::sun::star::lang::EventObject -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::sheet::ResultEvent::Value +{ + //------------------------------------------------------------------------- + /** contains the value. - - - + <p>This can be any of the possible return types described for the <type>AddIn</type> service, except <type>XVolatileResult</type>.</p> */ - any Value; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + any Value; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/Scenarios.idl b/offapi/com/sun/star/sheet/Scenarios.idl index 638bf0235..e9d5e78f3 100644 --- a/offapi/com/sun/star/sheet/Scenarios.idl +++ b/offapi/com/sun/star/sheet/Scenarios.idl @@ -2,9 +2,9 @@ * * $RCSfile: Scenarios.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: nn $ $Date: 2001-02-16 10:15:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,49 +58,58 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_Scenarios_idl__ -#define __com_sun_star_sheet_Scenarios_idl__ - -#ifndef __com_sun_star_sheet_XScenariosSupplier_idl__ -#include <com/sun/star/sheet/XScenariosSupplier.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::Scenarios -/** a collection of scenarios. + +#ifndef __com_sun_star_sheet_Scenarios_idl__ +#define __com_sun_star_sheet_Scenarios_idl__ + +#ifndef __com_sun_star_sheet_XScenariosSupplier_idl__ +#include <com/sun/star/sheet/XScenariosSupplier.idl> +#endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of scenarios. */ service Scenarios -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XScenarios; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access via name to the scenarios in the collection. + */ + interface com::sun::star::sheet::XScenarios; + + //------------------------------------------------------------------------- + + /** creates an enumeration of scenarios. + + @see com::sun::star::sheet::ScenariosEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + + //------------------------------------------------------------------------- + + /** provides access to the scenarios in the collection via index. + + @see com::sun::star::sheet::Spreadsheet + + */ + interface com::sun::star::container::XIndexAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/ScenariosEnumeration.idl b/offapi/com/sun/star/sheet/ScenariosEnumeration.idl new file mode 100644 index 000000000..b4eed4bbe --- /dev/null +++ b/offapi/com/sun/star/sheet/ScenariosEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: ScenariosEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:57 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_ScenariosEnumeration_idl__ +#define __com_sun_star_sheet_ScenariosEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of scenarios. + + @see com::sun::star::sheet::Spreadsheet + */ +service ScenariosEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the scenarios in the enumeration. + + @see com::sun::star::sheet::Spreadsheet + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SheetCell.idl b/offapi/com/sun/star/sheet/SheetCell.idl index 918488d54..93599071c 100644 --- a/offapi/com/sun/star/sheet/SheetCell.idl +++ b/offapi/com/sun/star/sheet/SheetCell.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetCell.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,82 +58,271 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SheetCell_idl__ #define __com_sun_star_sheet_SheetCell_idl__ + #ifndef __com_sun_star_table_Cell_idl__ #include <com/sun/star/table/Cell.idl> #endif -#ifndef __com_sun_star_sheet_XCellAddressable_idl__ -#include <com/sun/star/sheet/XCellAddressable.idl> +#ifndef __com_sun_star_text_Text_idl__ +#include <com/sun/star/text/Text.idl> #endif #ifndef __com_sun_star_style_CharacterProperties_idl__ #include <com/sun/star/style/CharacterProperties.idl> #endif +#ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__ +#include <com/sun/star/style/CharacterPropertiesAsian.idl> +#endif + +#ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__ +#include <com/sun/star/style/CharacterPropertiesComplex.idl> +#endif + #ifndef __com_sun_star_style_ParagraphProperties_idl__ #include <com/sun/star/style/ParagraphProperties.idl> #endif +#ifndef __com_sun_star_sheet_SheetRangesQuery_idl__ +#include <com/sun/star/sheet/SheetRangesQuery.idl> +#endif + + #ifndef __com_sun_star_document_XActionLockable_idl__ #include <com/sun/star/document/XActionLockable.idl> #endif +#ifndef __com_sun_star_util_XReplaceable_idl__ +#include <com/sun/star/util/XReplaceable.idl> +#endif + +#ifndef __com_sun_star_util_XIndent_idl__ +#include <com/sun/star/util/XIndent.idl> +#endif + +#ifndef __com_sun_star_table_XColumnRowRange_idl__ +#include <com/sun/star/table/XColumnRowRange.idl> +#endif + +#ifndef __com_sun_star_sheet_XCellAddressable_idl__ +#include <com/sun/star/sheet/XCellAddressable.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetAnnotationAnchor_idl__ +#include <com/sun/star/sheet/XSheetAnnotationAnchor.idl> +#endif + +#ifndef __com_sun_star_text_XTextFieldsSupplier_idl__ +#include <com/sun/star/text/XTextFieldsSupplier.idl> +#endif + + +#ifndef __com_sun_star_awt_Point_idl__ +#include <com/sun/star/awt/Point.idl> +#endif + +#ifndef __com_sun_star_awt_Size_idl__ +#include <com/sun/star/awt/Size.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__ +#include <com/sun/star/sheet/XSheetConditionalEntries.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SheetCell -/** a cell which can be addressed. +/** represents a single addressable cell in a spreadsheet document. */ service SheetCell { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides basic cell handling and contributes common cell + formatting properties. + */ service com::sun::star::table::Cell; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides handling of formatted text cells. + */ + service com::sun::star::text::Text; + + //------------------------------------------------------------------------- + + /** contributes properties for character formatting of Western text. + */ service com::sun::star::style::CharacterProperties; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** 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; - // DocMerge: empty anyway - interface com::sun::star::sheet::XCellAddressable; + //------------------------------------------------------------------------- - /** locks the update between XCell and XText + /** provides interfaces to find cells with specific properties. + */ + service com::sun::star::sheet::SheetRangesQuery; + + //========================================================================= + + /** provides methods to lock and unlock the update between + <type scope="com::sun::star::table">XCell</type> and + <type scope="com::sun::star::text">XText</type>. */ interface com::sun::star::document::XActionLockable; -}; -//============================================================================= + //------------------------------------------------------------------------- -}; }; }; }; + /** provides "Find & Replace" functionality. + + <p>The property + <member scope="com::sun::star::util">SearchDescriptor::SearchWords</member> + has a different meaning in spreadsheets: If set to <TRUE/>, the + spreadsheet searches for cells containing the serch text only.</p> + */ + interface com::sun::star::util::XReplaceable; + + //------------------------------------------------------------------------- + + /** provides modifying the cell indentation. + */ + interface com::sun::star::util::XIndent; + + //------------------------------------------------------------------------- + + /** provides access to the collections of columns and rows. + */ + interface com::sun::star::table::XColumnRowRange; + + //------------------------------------------------------------------------- + + /** provides access to the cell address of this cell. + */ + interface com::sun::star::sheet::XCellAddressable; + + //------------------------------------------------------------------------- + + /** provides access to the annotation attached to this cell. + */ + interface com::sun::star::sheet::XSheetAnnotationAnchor; + + //------------------------------------------------------------------------- + + /** provides access to the text fields used in this cell. + */ + interface com::sun::star::text::XTextFieldsSupplier; + + //========================================================================= + + /** contains the position of this cell in the sheet (in 1/100 mm). + + <p>This property contains the absolute position in the whole + sheet, not the position in the visible area.</p> + */ + [readonly, property] com::sun::star::awt::Point Position; + + //------------------------------------------------------------------------- + + /** contains the size of this cell (in 1/100 mm). + */ + [readonly, property] com::sun::star::awt::Size Size; -/*============================================================================= + //------------------------------------------------------------------------- - $Log: not supported by cvs2svn $ - Revision 1.4 2001/06/12 12:46:36 sab - #79771#; XActionLockable added - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api + /** contains the formula string with localized function names. - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import + <p>This property can also be used to set a new localized formula.</p> + */ + [optional, property] string FormulaLocal; - Revision 1.4 2000/09/11 11:52:49 mi - documentation merged from XML + //------------------------------------------------------------------------- - Revision 1.2 2000/08/02 10:28:00 mi - CharacterProperties and ParagraphProperties (were in table/Cell... before) + /** contains the result type of a formula. - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new + @see com::sun::star::sheet::FormulaResult + */ + [readonly, property] long FormulaResultType; + //------------------------------------------------------------------------- + + /** contains the conditional formatting settings for this cell. + + <p>After a conditional format has been changed it has to be + reinserted into the property set.</p> + + @see com::sun::star::sheet::TableConditionalFormat + */ + [property] com::sun::star::sheet::XSheetConditionalEntries + ConditionalFormat; + + //------------------------------------------------------------------------- + + /** contains the conditional formatting settings for this cell, + using localized formulas. + + <p>After a conditional format has been changed it has to be + reinserted into the property set.</p> + + @see com::sun::star::sheet::TableConditionalFormat + */ + [optional, property] com::sun::star::sheet::XSheetConditionalEntries + ConditionalFormatLocal; + + //------------------------------------------------------------------------- + + /** contains the data validation settings for this cell. + + <p>After the data validation settings have been changed the + validation has to be reinserted into the property set.</p> + + @see com::sun::star::sheet::TableValidation + */ + [property] com::sun::star::beans::XPropertySet Validation; + + //------------------------------------------------------------------------- + + /** contains the data validation settings for this cell, + using localized formulas. + + <p>After the data validation settings have been changed the + validation has to be reinserted into the property set.</p> + + @see com::sun::star::sheet::TableValidation + */ + [optional, property] com::sun::star::beans::XPropertySet ValidationLocal; + +}; + +//============================================================================= + +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SheetCellCursor.idl b/offapi/com/sun/star/sheet/SheetCellCursor.idl index 3a3602ccf..2ddb46284 100644 --- a/offapi/com/sun/star/sheet/SheetCellCursor.idl +++ b/offapi/com/sun/star/sheet/SheetCellCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetCellCursor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,67 +58,69 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_SheetCellCursor_idl__ -#define __com_sun_star_sheet_SheetCellCursor_idl__ - -#ifndef __com_sun_star_table_CellCursor_idl__ -#include <com/sun/star/table/CellCursor.idl> -#endif - -#ifndef __com_sun_star_sheet_SheetCellRange_idl__ -#include <com/sun/star/sheet/SheetCellRange.idl> -#endif - -#ifndef __com_sun_star_sheet_XSheetCellCursor_idl__ -#include <com/sun/star/sheet/XSheetCellCursor.idl> -#endif - -#ifndef __com_sun_star_sheet_XUsedAreaCursor_idl__ -#include <com/sun/star/sheet/XUsedAreaCursor.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::SheetCellCursor -/** a cursor in a spreadsheet. + +#ifndef __com_sun_star_sheet_SheetCellCursor_idl__ +#define __com_sun_star_sheet_SheetCellCursor_idl__ + +#ifndef __com_sun_star_table_CellCursor_idl__ +#include <com/sun/star/table/CellCursor.idl> +#endif + +#ifndef __com_sun_star_sheet_SheetCellRange_idl__ +#include <com/sun/star/sheet/SheetCellRange.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetCellCursor_idl__ +#include <com/sun/star/sheet/XSheetCellCursor.idl> +#endif + +#ifndef __com_sun_star_sheet_XUsedAreaCursor_idl__ +#include <com/sun/star/sheet/XUsedAreaCursor.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a cursor in a spreadsheet. + + <p>A cursor is a cell range which provides additional methods to move + through the table (i.e. to find specific cell ranges).</p> */ service SheetCellCursor -{ - // DocMerge: empty anyway - service com::sun::star::table::CellCursor; - - // DocMerge: empty anyway - service com::sun::star::sheet::SheetCellRange; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetCellCursor; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XUsedAreaCursor; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides common methods to control the position of the cursor. + */ + service com::sun::star::table::CellCursor; + + //------------------------------------------------------------------------- + + /** provides the complete functionality of a cell range in a spreadsheet + document. + */ + service com::sun::star::sheet::SheetCellRange; + + //========================================================================= + + /** provides advanced methods to control the position of the cursor. + */ + interface com::sun::star::sheet::XSheetCellCursor; + + //------------------------------------------------------------------------- + + /** provides methods to find the used area of the entire sheet. + */ + interface com::sun::star::sheet::XUsedAreaCursor; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SheetCellRange.idl b/offapi/com/sun/star/sheet/SheetCellRange.idl index a370085fa..a9fc1e3e1 100644 --- a/offapi/com/sun/star/sheet/SheetCellRange.idl +++ b/offapi/com/sun/star/sheet/SheetCellRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetCellRange.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,141 +58,370 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_SheetCellRange_idl__ -#define __com_sun_star_sheet_SheetCellRange_idl__ - -#ifndef __com_sun_star_util_XMergeable_idl__ -#include <com/sun/star/util/XMergeable.idl> -#endif - -#ifndef __com_sun_star_table_CellRange_idl__ -#include <com/sun/star/table/CellRange.idl> -#endif - -#ifndef __com_sun_star_table_XColumnRowRange_idl__ -#include <com/sun/star/table/XColumnRowRange.idl> -#endif - -#ifndef __com_sun_star_sheet_XCellRangeAddressable_idl__ -#include <com/sun/star/sheet/XCellRangeAddressable.idl> -#endif - -#ifndef __com_sun_star_sheet_XSheetOperation_idl__ -#include <com/sun/star/sheet/XSheetOperation.idl> -#endif - -#ifndef __com_sun_star_awt_Point_idl__ -#include <com/sun/star/awt/Point.idl> -#endif - -#ifndef __com_sun_star_awt_Size_idl__ -#include <com/sun/star/awt/Size.idl> -#endif - -#ifndef __com_sun_star_style_CharacterProperties_idl__ -#include <com/sun/star/style/CharacterProperties.idl> -#endif - -#ifndef __com_sun_star_style_ParagraphProperties_idl__ -#include <com/sun/star/style/ParagraphProperties.idl> -#endif - -#ifndef __com_sun_star_chart_XChartData_idl__ -#include <com/sun/star/chart/XChartData.idl> -#endif - -//============================================================================= - - module com { module sun { module star { module sheet { - -interface XArrayFormulaRange; - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::SheetCellRange -/** an extension of the CellRange service for use - in spreadsheet documents.@see com::sun::star::table::CellRange + +#ifndef __com_sun_star_sheet_SheetCellRange_idl__ +#define __com_sun_star_sheet_SheetCellRange_idl__ + + +#ifndef __com_sun_star_table_CellRange_idl__ +#include <com/sun/star/table/CellRange.idl> +#endif + +#ifndef __com_sun_star_style_CharacterProperties_idl__ +#include <com/sun/star/style/CharacterProperties.idl> +#endif + +#ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__ +#include <com/sun/star/style/CharacterPropertiesAsian.idl> +#endif + +#ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__ +#include <com/sun/star/style/CharacterPropertiesComplex.idl> +#endif + +#ifndef __com_sun_star_style_ParagraphProperties_idl__ +#include <com/sun/star/style/ParagraphProperties.idl> +#endif + +#ifndef __com_sun_star_sheet_SheetRangesQuery_idl__ +#include <com/sun/star/sheet/SheetRangesQuery.idl> +#endif + + +#ifndef __com_sun_star_util_XReplaceable_idl__ +#include <com/sun/star/util/XReplaceable.idl> +#endif + +#ifndef __com_sun_star_util_XMergeable_idl__ +#include <com/sun/star/util/XMergeable.idl> +#endif + +#ifndef __com_sun_star_util_XIndent_idl__ +#include <com/sun/star/util/XIndent.idl> +#endif + +#ifndef __com_sun_star_table_XColumnRowRange_idl__ +#include <com/sun/star/table/XColumnRowRange.idl> +#endif + +#ifndef __com_sun_star_table_XAutoFormattable_idl__ +#include <com/sun/star/table/XAutoFormattable.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetCellRange_idl__ +#include <com/sun/star/sheet/XSheetCellRange.idl> +#endif + +#ifndef __com_sun_star_sheet_XCellRangeData_idl__ +#include <com/sun/star/sheet/XCellRangeData.idl> +#endif + +#ifndef __com_sun_star_sheet_XCellRangeAddressable_idl__ +#include <com/sun/star/sheet/XCellRangeAddressable.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetOperation_idl__ +#include <com/sun/star/sheet/XSheetOperation.idl> +#endif + +#ifndef __com_sun_star_sheet_XCellSeries_idl__ +#include <com/sun/star/sheet/XCellSeries.idl> +#endif + +#ifndef __com_sun_star_sheet_XArrayFormulaRange_idl__ +#include <com/sun/star/sheet/XArrayFormulaRange.idl> +#endif + +#ifndef __com_sun_star_sheet_XMultipleOperation_idl__ +#include <com/sun/star/sheet/XMultipleOperation.idl> +#endif + +#ifndef __com_sun_star_util_XSortable_idl__ +#include <com/sun/star/util/XSortable.idl> +#endif + +#ifndef __com_sun_star_util_XImportable_idl__ +#include <com/sun/star/util/XImportable.idl> +#endif + +#ifndef __com_sun_star_sheet_XSubTotalCalculatable_idl__ +#include <com/sun/star/sheet/XSubTotalCalculatable.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetFilterableEx_idl__ +#include <com/sun/star/sheet/XSheetFilterableEx.idl> +#endif + +#ifndef __com_sun_star_sheet_XCellFormatRangesSupplier_idl__ +#include <com/sun/star/sheet/XCellFormatRangesSupplier.idl> +#endif + +#ifndef __com_sun_star_sheet_XUniqueCellFormatRangesSupplier_idl__ +#include <com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl> +#endif + +#ifndef __com_sun_star_chart_XChartDataArray_idl__ +#include <com/sun/star/chart/XChartDataArray.idl> +#endif + + +#ifndef __com_sun_star_awt_Point_idl__ +#include <com/sun/star/awt/Point.idl> +#endif + +#ifndef __com_sun_star_awt_Size_idl__ +#include <com/sun/star/awt/Size.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__ +#include <com/sun/star/sheet/XSheetConditionalEntries.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a rectangular range of cells in a spreadsheet document. + + <p>This service is an extension of the CellRange service for use + in spreadsheet documents.</p> */ service SheetCellRange -{ - // DocMerge: empty anyway - service com::sun::star::table::CellRange; - - // DocMerge: empty anyway - service com::sun::star::style::CharacterProperties; - - // DocMerge: empty anyway - service com::sun::star::style::ParagraphProperties; - - // DocMerge: empty anyway - interface com::sun::star::util::XMergeable; - - // DocMerge: empty anyway - interface com::sun::star::table::XColumnRowRange; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XArrayFormulaRange; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XCellRangeAddressable; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetOperation; - - /** offers the cell range for a chart. Makes it possible to learn - about changes in the cell values. */ - interface com::sun::star::chart::XChartData; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SheetCellRange::Position - /** contains the position of the range on the sheet. - */ - [readonly, property] com::sun::star::awt::Point Position; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SheetCellRange::Size - /** contains the size of the range. - */ - [readonly, property] com::sun::star::awt::Size Size; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/21 11:28:28 mi - XChartData is accessible, documentation was missing - - 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:46 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:47 hjs - initial import - - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.3 2000/08/02 10:28:00 mi - CharacterProperties and ParagraphProperties (were in table/Cell... before) - - Revision 1.2 2000/02/09 15:07:24 mi - #72869# get/setCellStyle moved to CellProperties - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides basic handling of cell ranges and contributes common cell + formatting properties. + */ + service com::sun::star::table::CellRange; + + //------------------------------------------------------------------------- + + /** 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. + + <p>The property + <member scope="com::sun::star::util">SearchDescriptor::SearchWords</member> + has a different meaning in spreadsheets: If set to <TRUE/>, the + spreadsheet searches for cells containing the serch text only.</p> + */ + interface com::sun::star::util::XReplaceable; + + //------------------------------------------------------------------------- + + /** provides merging and unmerging the cells of this cell range. + */ + interface com::sun::star::util::XMergeable; + + //------------------------------------------------------------------------- + + /** provides modifying the cell indentation. + */ + interface com::sun::star::util::XIndent; + + //------------------------------------------------------------------------- + + /** provides access to the collections of columns and rows. + */ + interface com::sun::star::table::XColumnRowRange; + + //------------------------------------------------------------------------- + + /** provides applying an AutoFormat to the cell range. + */ + interface com::sun::star::table::XAutoFormattable; + + //------------------------------------------------------------------------- + + /** provides access to the spreadsheet that contains this cell range. + */ + interface com::sun::star::sheet::XSheetCellRange; + + //------------------------------------------------------------------------- + + /** provides simultaneous access to the contents of all cells. + */ + interface com::sun::star::sheet::XCellRangeData; + + //------------------------------------------------------------------------- + + /** provides access to the cell range address of this range. + */ + interface com::sun::star::sheet::XCellRangeAddressable; + + //------------------------------------------------------------------------- + + /** 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 filling out the cell range automatically with values based + on a start value, step count and fill mode. + */ + interface com::sun::star::sheet::XCellSeries; + + //------------------------------------------------------------------------- + + /** provides handling of array formulas. + */ + interface com::sun::star::sheet::XArrayFormulaRange; + + //------------------------------------------------------------------------- + + /** provides access to the Multiple Operations feature. + */ + interface com::sun::star::sheet::XMultipleOperation; + + //------------------------------------------------------------------------- + + /** provides sorting functionality. + */ + interface com::sun::star::util::XSortable; + + //------------------------------------------------------------------------- + + /** provides functionality to import data from external data sources. + */ + interface com::sun::star::util::XImportable; + + //------------------------------------------------------------------------- + + /** provides calculating SubTotal values in this range. + */ + interface com::sun::star::sheet::XSubTotalCalculatable; + + //------------------------------------------------------------------------- + + /** provides filtering the contents of this range. + */ + interface com::sun::star::sheet::XSheetFilterableEx; + + //------------------------------------------------------------------------- + + /** provide access to a collection of equal-formatted cell ranges. + */ + interface com::sun::star::sheet::XCellFormatRangesSupplier; + + //------------------------------------------------------------------------- + + /** provide access to a collection of equal-formatted cell ranges. + */ + interface com::sun::star::sheet::XUniqueCellFormatRangesSupplier; + + //------------------------------------------------------------------------- + + /** 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; + + //========================================================================= + + /** contains the position of the top left cell of this range in + the sheet (in 1/100 mm). + + <p>This property contains the absolute position in the whole + sheet, not the position in the visible area.</p> + */ + [readonly, property] com::sun::star::awt::Point Position; + + //------------------------------------------------------------------------- + + /** contains the size of this range (in 1/100 mm). + */ + [readonly, property] com::sun::star::awt::Size Size; + + //------------------------------------------------------------------------- + + /** contains the conditional formatting settings for this cell. + + <p>After a conditional format has been changed it has to be + reinserted into the property set.</p> + + @see com::sun::star::sheet::TableConditionalFormat + */ + [property] com::sun::star::sheet::XSheetConditionalEntries + ConditionalFormat; + + //------------------------------------------------------------------------- + + /** contains the conditional formatting settings for this cell, + using localized formulas. + + <p>After a conditional format has been changed it has to be + reinserted into the property set.</p> + + @see com::sun::star::sheet::TableConditionalFormat + */ + [optional, property] com::sun::star::sheet::XSheetConditionalEntries + ConditionalFormatLocal; + + //------------------------------------------------------------------------- + + /** contains the data validation settings for this cell. + + <p>After the data validation settings have been changed the + validation has to be reinserted into the property set.</p> + + @see com::sun::star::sheet::TableValidation + */ + [property] com::sun::star::beans::XPropertySet Validation; + + //------------------------------------------------------------------------- + + /** contains the data validation settings for this cell, + using localized formulas. + + <p>After the data validation settings have been changed the + validation has to be reinserted into the property set.</p> + + @see com::sun::star::sheet::TableValidation + */ + [optional, property] com::sun::star::beans::XPropertySet ValidationLocal; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SheetCellRanges.idl b/offapi/com/sun/star/sheet/SheetCellRanges.idl index cd59c50d3..8b220ffa5 100644 --- a/offapi/com/sun/star/sheet/SheetCellRanges.idl +++ b/offapi/com/sun/star/sheet/SheetCellRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetCellRanges.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: sab $ $Date: 2001-07-06 11:48:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,27 +58,58 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SheetCellRanges_idl__ #define __com_sun_star_sheet_SheetCellRanges_idl__ + #ifndef __com_sun_star_table_CellProperties_idl__ #include <com/sun/star/table/CellProperties.idl> #endif -#ifndef __com_sun_star_sheet_XSheetCellRangeContainer_idl__ -#include <com/sun/star/sheet/XSheetCellRangeContainer.idl> +#ifndef __com_sun_star_style_CharacterProperties_idl__ +#include <com/sun/star/style/CharacterProperties.idl> +#endif + +#ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__ +#include <com/sun/star/style/CharacterPropertiesAsian.idl> +#endif + +#ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__ +#include <com/sun/star/style/CharacterPropertiesComplex.idl> +#endif + +#ifndef __com_sun_star_style_ParagraphProperties_idl__ +#include <com/sun/star/style/ParagraphProperties.idl> +#endif + +#ifndef __com_sun_star_sheet_SheetRangesQuery_idl__ +#include <com/sun/star/sheet/SheetRangesQuery.idl> +#endif + + +#ifndef __com_sun_star_util_XReplaceable_idl__ +#include <com/sun/star/util/XReplaceable.idl> +#endif + +#ifndef __com_sun_star_util_XIndent_idl__ +#include <com/sun/star/util/XIndent.idl> #endif #ifndef __com_sun_star_sheet_XSheetOperation_idl__ #include <com/sun/star/sheet/XSheetOperation.idl> #endif -#ifndef __com_sun_star_container_XEnumerationAccess_idl__ -#include <com/sun/star/container/XEnumerationAccess.idl> +#ifndef __com_sun_star_chart_XChartDataArray_idl__ +#include <com/sun/star/chart/XChartDataArray.idl> #endif -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> +#ifndef __com_sun_star_sheet_XSheetCellRangeContainer_idl__ +#include <com/sun/star/sheet/XSheetCellRangeContainer.idl> +#endif + +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> #endif #ifndef __com_sun_star_container_XNameContainer_idl__ @@ -86,56 +117,170 @@ #endif +#ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__ +#include <com/sun/star/sheet/XSheetConditionalEntries.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SheetCellRanges -/** a collection of cell ranges. +/** represents a collection of cell ranges in a spreadsheet document. + + @see com::sun::star::sheet::SheetCellRange */ service SheetCellRanges { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** contributes common cell formatting properties. + */ service com::sun::star::table::CellProperties; - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetCellRangeContainer; + //------------------------------------------------------------------------- + + /** 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; + + //------------------------------------------------------------------------- - // DocMerge: empty anyway + /** 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. + + <p>The property + <member scope="com::sun::star::util">SearchDescriptor::SearchWords</member> + has a different meaning in spreadsheets: If set to <TRUE/>, the + spreadsheet searches for cells containing the serch text only.</p> + */ + 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; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** 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; - // DocMerge: empty anyway - interface com::sun::star::container::XIndexAccess; + //------------------------------------------------------------------------- - // DocMerge: empty anyway + /** provides access of the cell ranges via an user-defined name. + + <p>Later the range can be found, replaced or removed using that + name.</p> + */ interface com::sun::star::container::XNameContainer; -}; + //========================================================================= -//============================================================================= + /** contains the conditional formatting settings for this cell. -}; }; }; }; + <p>After a conditional format has been changed it has to be + reinserted into the property set.</p> + + @see com::sun::star::sheet::TableConditionalFormat + */ + [property] com::sun::star::sheet::XSheetConditionalEntries + ConditionalFormat; + + //------------------------------------------------------------------------- + + /** contains the conditional formatting settings for this cell, + using localized formulas. + + <p>After a conditional format has been changed it has to be + reinserted into the property set.</p> + + @see com::sun::star::sheet::TableConditionalFormat + */ + [optional, property] com::sun::star::sheet::XSheetConditionalEntries + ConditionalFormatLocal; -/*============================================================================= + //------------------------------------------------------------------------- - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api + /** contains the data validation settings for this cell. - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import + <p>After the data validation settings have been changed the + validation has to be reinserted into the property set.</p> - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML + @see com::sun::star::sheet::TableValidation + */ + [property] com::sun::star::beans::XPropertySet Validation; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new + //------------------------------------------------------------------------- + /** contains the data validation settings for this cell, + using localized formulas. + + <p>After the data validation settings have been changed the + validation has to be reinserted into the property set.</p> + + @see com::sun::star::sheet::TableValidation + */ + [optional, property] com::sun::star::beans::XPropertySet ValidationLocal; + +}; + +//============================================================================= + +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SheetCellRangesEnumeration.idl b/offapi/com/sun/star/sheet/SheetCellRangesEnumeration.idl new file mode 100644 index 000000000..7afee309f --- /dev/null +++ b/offapi/com/sun/star/sheet/SheetCellRangesEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: SheetCellRangesEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:58 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_SheetCellRangesEnumeration_idl__ +#define __com_sun_star_sheet_SheetCellRangesEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of cell ranges in a spreadsheet document. + + @see com::sun::star::sheet::SheetCellRanges + */ +service SheetCellRangesEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the cell ranges in the enumeration. + + @see com::sun::star::sheet::SheetCellRange + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl b/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl index 839556ae1..ecaac6ccb 100644 --- a/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl +++ b/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetFilterDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,151 +58,125 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_SheetFilterDescriptor_idl__ -#define __com_sun_star_sheet_SheetFilterDescriptor_idl__ - -#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__ -#include <com/sun/star/sheet/XSheetFilterDescriptor.idl> -#endif - -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - -#ifndef __com_sun_star_table_TableOrientation_idl__ -#include <com/sun/star/table/TableOrientation.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::SheetFilterDescriptor -/** a description of how a cell range is to be filtered. + +#ifndef __com_sun_star_sheet_SheetFilterDescriptor_idl__ +#define __com_sun_star_sheet_SheetFilterDescriptor_idl__ + +#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__ +#include <com/sun/star/sheet/XSheetFilterDescriptor.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +#ifndef __com_sun_star_table_TableOrientation_idl__ +#include <com/sun/star/table/TableOrientation.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a description of how a cell range is to be filtered. + + <p>The descriptor contains properties and a collection of filter + conditions (filter fields) which control the behaviour of a filter + operation.</p> */ service SheetFilterDescriptor -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetFilterDescriptor; - - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetFilterDescriptor::IsCaseSensitive - - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::IsCaseSensitive +{ + //------------------------------------------------------------------------- + + /** provides access to the collection of filter fields. + */ + interface com::sun::star::sheet::XSheetFilterDescriptor; + + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + //========================================================================= + /** specifies if the case of letters is important when comparing entries. */ - [property] boolean IsCaseSensitive; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetFilterDescriptor::SkipDuplicates - - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::SkipDuplicates + [property] boolean IsCaseSensitive; + + //------------------------------------------------------------------------- + /** specifies if duplicate entries are left out of the result. */ - [property] boolean SkipDuplicates; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetFilterDescriptor::UseRegularExpressions - - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::UseRegularExpressions + [property] boolean SkipDuplicates; + + //------------------------------------------------------------------------- + /** specifies if the <member>TableFilterField::StringValue</member> strings are interpreted as regular expressions. */ - [property] boolean UseRegularExpressions; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetFilterDescriptor::SaveOutputPosition - - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::SaveOutputPosition - /** specifies if the <member>SheetFilterDescriptor::OutputPosition</member> position is saved - for future calls. - - - - <p>This is only used if <member>SheetFilterDescriptor::CopyOutputData</member> is <TRUE/>.</p> + [property] boolean UseRegularExpressions; + + //------------------------------------------------------------------------- + + /** specifies if the <member>SheetFilterDescriptor::OutputPosition</member> + position is saved for future calls. + + <p>This is only used if + <member>SheetFilterDescriptor::CopyOutputData</member> is <TRUE/>.</p> */ - [property] boolean SaveOutputPosition; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::Orientation + [property] boolean SaveOutputPosition; + + //------------------------------------------------------------------------- + /** specifies if columns or rows are filtered. */ - [property] com::sun::star::table::TableOrientation Orientation; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::ContainsHeader - /** specifies if the first row (or column) - contains headers which should not be filtered. + [property] com::sun::star::table::TableOrientation Orientation; + + //------------------------------------------------------------------------- + + /** specifies if the first row (or column) contains headers which should + not be filtered. */ - [property] boolean ContainsHeader; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::CopyOutputData - /** specifies if the filtered data should - be copied to another position in the document. + [property] boolean ContainsHeader; + + //------------------------------------------------------------------------- + + /** specifies if the filtered data should be copied to another position + in the document. */ - [property] boolean CopyOutputData; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::OutputPosition - /** specifies the position where filtered data - are to be copied. - - - - <p>This is only used if <member>SheetFilterDescriptor::CopyOutputData</member> is <TRUE/>.</p> + [property] boolean CopyOutputData; + + //------------------------------------------------------------------------- + + /** specifies the position where filtered data are to be copied. + + <p>This is only used if + <member>SheetFilterDescriptor::CopyOutputData</member> is <TRUE/>.</p> */ - [property] com::sun::star::table::CellAddress OutputPosition; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::MaxFieldCount - /** returns the maximum number of filter fields - in the descriptor. + [property] com::sun::star::table::CellAddress OutputPosition; + + //------------------------------------------------------------------------- + + /** returns the maximum number of filter fields in the descriptor. + + <p>This read-only property indicates the maximum count of fields the + current implementation supports.</p> */ - [readonly, property] long MaxFieldCount; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [readonly, property] long MaxFieldCount; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SheetLink.idl b/offapi/com/sun/star/sheet/SheetLink.idl index dbc6c5f88..e3e14c442 100644 --- a/offapi/com/sun/star/sheet/SheetLink.idl +++ b/offapi/com/sun/star/sheet/SheetLink.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetLink.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,89 +58,86 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_SheetLink_idl__ -#define __com_sun_star_sheet_SheetLink_idl__ - -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - -#ifndef __com_sun_star_util_XRefreshable_idl__ -#include <com/sun/star/util/XRefreshable.idl> -#endif - -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::SheetLink -/** a sheet link. + +#ifndef __com_sun_star_sheet_SheetLink_idl__ +#define __com_sun_star_sheet_SheetLink_idl__ + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +#ifndef __com_sun_star_util_XRefreshable_idl__ +#include <com/sun/star/util/XRefreshable.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a sheet link. + + <p>A sheet link contains the source data of linked sheets, i.e. the + URL and sheet name of the external document.</p> + + <p>To create a linked sheet, the sheet which will be used as linked + sheet has to exist already. The method + <member>XSheetLinkable::link</member> creates a <type>SheetLink</type> + object in the document's <type>SheetLinks</type> collection and links + the sheet to the specified external sheet.</p> */ service SheetLink -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; - - // DocMerge: empty anyway - interface com::sun::star::util::XRefreshable; - - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SheetLink::Url +{ + //------------------------------------------------------------------------- + + /** provides access to the name of the linked document. + + <p>This name is equal to the <const>Url</const> property.</p> + */ + interface com::sun::star::container::XNamed; + + //------------------------------------------------------------------------- + + /** provides methods to reload the external data. + */ + interface com::sun::star::util::XRefreshable; + + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + //========================================================================= + /** specifies the URL of the source document. */ - [property] string Url; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SheetLink::Filter - /** specifies the name of the filter needed - to load the source document. + [property] string Url; + + //------------------------------------------------------------------------- + + /** specifies the name of the filter needed to load the source + document. */ - [property] string Filter; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SheetLink::FilterOptions - /** specifies the filter options needed - to load the source document. + [property] string Filter; + + //------------------------------------------------------------------------- + + /** specifies the filter options needed to load the source document. */ - [property] string FilterOptions; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:08 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [property] string FilterOptions; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SheetLinkMode.idl b/offapi/com/sun/star/sheet/SheetLinkMode.idl index e2a5c1a64..7047fc827 100644 --- a/offapi/com/sun/star/sheet/SheetLinkMode.idl +++ b/offapi/com/sun/star/sheet/SheetLinkMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetLinkMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,60 +58,47 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_SheetLinkMode_idl__ -#define __com_sun_star_sheet_SheetLinkMode_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::SheetLinkMode + +#ifndef __com_sun_star_sheet_SheetLinkMode_idl__ +#define __com_sun_star_sheet_SheetLinkMode_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** used to specify how a sheet is linked to another sheet. + + @see com::sun::star::sheet::SheetLinks + @see com::sun::star::sheet::SheetLink + @see com::sun::star::sheet::XSheetLinkable */ enum SheetLinkMode -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::SheetLinkMode::NONE +{ + //------------------------------------------------------------------------- + /** sheet is not linked. */ - NONE, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::SheetLinkMode::NORMAL - /** all contents are copied. + NONE, + + //------------------------------------------------------------------------- + + /** all contents (values and formulas) are copied. */ - NORMAL, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::SheetLinkMode::VALUE + NORMAL, + + //------------------------------------------------------------------------- + /** instead of using formulas, the result values are copied. */ - VALUE - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + VALUE + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SheetLinks.idl b/offapi/com/sun/star/sheet/SheetLinks.idl index bfabf5a38..f08a3395a 100644 --- a/offapi/com/sun/star/sheet/SheetLinks.idl +++ b/offapi/com/sun/star/sheet/SheetLinks.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetLinks.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,66 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_SheetLinks_idl__ -#define __com_sun_star_sheet_SheetLinks_idl__ - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::SheetLinks -/** a collection of sheet links. + +#ifndef __com_sun_star_sheet_SheetLinks_idl__ +#define __com_sun_star_sheet_SheetLinks_idl__ + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of sheet links. + + @see com::sun::star::sheet::SheetLink + @see com::sun::star::sheet::SpreadsheetDocument */ service SheetLinks -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access to the sheet links via index. + + @see com::sun::star::sheet::SheetLink + + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + + /** provides access to the sheet links using the name of the linked + document. + + @see com::sun::star::sheet::SheetLink + + */ + interface com::sun::star::container::XNameAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all sheet links. + + @see com::sun::star::sheet::SheetLinksEnumeration + + */ + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SheetLinksEnumeration.idl b/offapi/com/sun/star/sheet/SheetLinksEnumeration.idl new file mode 100644 index 000000000..807fe0bdb --- /dev/null +++ b/offapi/com/sun/star/sheet/SheetLinksEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: SheetLinksEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:00 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_SheetLinksEnumeration_idl__ +#define __com_sun_star_sheet_SheetLinkssEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of sheet links. + + @see com::sun::star::sheet::SheetLink + */ +service SheetLinksEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the sheet links in the enumeration. + + @see com::sun::star::sheet::SheetLink + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SheetRangesQuery.idl b/offapi/com/sun/star/sheet/SheetRangesQuery.idl index 0f8e6b483..0eed4141f 100644 --- a/offapi/com/sun/star/sheet/SheetRangesQuery.idl +++ b/offapi/com/sun/star/sheet/SheetRangesQuery.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetRangesQuery.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,53 +58,45 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_SheetRangesQuery_idl__ -#define __com_sun_star_sheet_SheetRangesQuery_idl__ - -#ifndef __com_sun_star_sheet_XCellRangesQuery_idl__ -#include <com/sun/star/sheet/XCellRangesQuery.idl> -#endif - -#ifndef __com_sun_star_sheet_XFormulaQuery_idl__ -#include <com/sun/star/sheet/XFormulaQuery.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::SheetRangesQuery -/** makes it possible to query for cells. + +#ifndef __com_sun_star_sheet_SheetRangesQuery_idl__ +#define __com_sun_star_sheet_SheetRangesQuery_idl__ + +#ifndef __com_sun_star_sheet_XCellRangesQuery_idl__ +#include <com/sun/star/sheet/XCellRangesQuery.idl> +#endif + +#ifndef __com_sun_star_sheet_XFormulaQuery_idl__ +#include <com/sun/star/sheet/XFormulaQuery.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides interfaces to find cells with specific properties. */ service SheetRangesQuery -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XCellRangesQuery; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XFormulaQuery; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides methods to query for cell ranges with specific contents. + */ + interface com::sun::star::sheet::XCellRangesQuery; + + //------------------------------------------------------------------------- + + /** provides methods to find dependent cells of formula cells. + */ + interface com::sun::star::sheet::XFormulaQuery; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SheetSortDescriptor.idl b/offapi/com/sun/star/sheet/SheetSortDescriptor.idl index 21c78d308..c7dd6c28a 100644 --- a/offapi/com/sun/star/sheet/SheetSortDescriptor.idl +++ b/offapi/com/sun/star/sheet/SheetSortDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetSortDescriptor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-03-14 16:31:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,110 +58,79 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_SheetSortDescriptor_idl__ -#define __com_sun_star_sheet_SheetSortDescriptor_idl__ - -#ifndef __com_sun_star_util_SortDescriptor_idl__ -#include <com/sun/star/util/SortDescriptor.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - -//============================================================================= - -module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::SheetSortDescriptor +#ifndef __com_sun_star_sheet_SheetSortDescriptor_idl__ +#define __com_sun_star_sheet_SheetSortDescriptor_idl__ + +#ifndef __com_sun_star_util_SortDescriptor_idl__ +#include <com/sun/star/util/SortDescriptor.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** a description of how a cell range is to be sorted. + + <p>This service extends the <type scope="com::sun::star::util">SortDescriptor</type> + service with spreadsheet specific properties.</p> */ service SheetSortDescriptor -{ +{ + //------------------------------------------------------------------------- + + /** provides common sorting properties. + */ service com::sun::star::util::SortDescriptor; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetSortDescriptor::BindFormatsToContent - - // DocMerge from xml: property com::sun::star::sheet::SheetSortDescriptor::BindFormatsToContent + //========================================================================= + /** specifies if cell formats are moved with the contents they belong to. */ - [property] boolean BindFormatsToContent; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetSortDescriptor::IsUserListEnabled - - // DocMerge from xml: property com::sun::star::sheet::SheetSortDescriptor::IsUserListEnabled + [property] boolean BindFormatsToContent; + + //------------------------------------------------------------------------- + /** specifies if a user defined sorting list is used. */ - [property] boolean IsUserListEnabled; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetSortDescriptor::UserListIndex - - // DocMerge from xml: property com::sun::star::sheet::SheetSortDescriptor::UserListIndex + [property] boolean IsUserListEnabled; + + //------------------------------------------------------------------------- + /** specifies which user defined sorting list is used. - - - - <p>This is only used if <member>SheetSortDescriptor::IsUserListEnabled</member> - is <TRUE/>.</p> + + <p>This property is only used, if + <member>SheetSortDescriptor::IsUserListEnabled</member> is <TRUE/>.</p> */ - [property] long UserListIndex; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SheetSortDescriptor::CopyOutputData - /** specifies if the sorted data should be - copied to another position in the document. + [property] long UserListIndex; + + //------------------------------------------------------------------------- + + /** specifies if the sorted data should be copied to another + position in the document. */ - [property] boolean CopyOutputData; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SheetSortDescriptor::OutputPosition - /** specifies the position where sorted data - are to be copied. - - - - <p>This is only used if UseOutputPosition is <TRUE/>.</p> + [property] boolean CopyOutputData; + + //------------------------------------------------------------------------- + + /** specifies the position where sorted data are to be copied. + + <p>This property is only used, if + <member>SheetSortDescriptor::CopyOutputData</member> is <TRUE/>.</p> */ - [property] com::sun::star::table::CellAddress OutputPosition; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:40 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [property] com::sun::star::table::CellAddress OutputPosition; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/Spreadsheet.idl b/offapi/com/sun/star/sheet/Spreadsheet.idl index 4e5ce0a5a..882474f13 100644 --- a/offapi/com/sun/star/sheet/Spreadsheet.idl +++ b/offapi/com/sun/star/sheet/Spreadsheet.idl @@ -2,9 +2,9 @@ * * $RCSfile: Spreadsheet.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,129 +58,203 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_Spreadsheet_idl__ -#define __com_sun_star_sheet_Spreadsheet_idl__ - -#ifndef __com_sun_star_sheet_SheetCellRange_idl__ -#include <com/sun/star/sheet/SheetCellRange.idl> -#endif - -#ifndef __com_sun_star_sheet_XSpreadsheet_idl__ -#include <com/sun/star/sheet/XSpreadsheet.idl> -#endif - -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - -#ifndef __com_sun_star_sheet_XSheetPageBreak_idl__ -#include <com/sun/star/sheet/XSheetPageBreak.idl> -#endif - -#ifndef __com_sun_star_sheet_XCellRangeMovement_idl__ -#include <com/sun/star/sheet/XCellRangeMovement.idl> -#endif - -#ifndef __com_sun_star_table_XTableChartsSupplier_idl__ -#include <com/sun/star/table/XTableChartsSupplier.idl> -#endif - -#ifndef __com_sun_star_sheet_XDataPilotTablesSupplier_idl__ -#include <com/sun/star/sheet/XDataPilotTablesSupplier.idl> -#endif - -#ifndef __com_sun_star_sheet_XScenariosSupplier_idl__ -#include <com/sun/star/sheet/XScenariosSupplier.idl> -#endif - -#ifndef __com_sun_star_sheet_XSheetAnnotationsSupplier_idl__ -#include <com/sun/star/sheet/XSheetAnnotationsSupplier.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::Spreadsheet -/** a 2-dimensional sheet of cells. + +#ifndef __com_sun_star_sheet_Spreadsheet_idl__ +#define __com_sun_star_sheet_Spreadsheet_idl__ + +#ifndef __com_sun_star_sheet_SheetCellRange_idl__ +#include <com/sun/star/sheet/SheetCellRange.idl> +#endif + +#ifndef __com_sun_star_sheet_XSpreadsheet_idl__ +#include <com/sun/star/sheet/XSpreadsheet.idl> +#endif + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +#ifndef __com_sun_star_util_XProtectable_idl__ +#include <com/sun/star/util/XProtectable.idl> +#endif + +#ifndef __com_sun_star_sheet_XDataPilotTablesSupplier_idl__ +#include <com/sun/star/sheet/XDataPilotTablesSupplier.idl> +#endif + +#ifndef __com_sun_star_sheet_XScenariosSupplier_idl__ +#include <com/sun/star/sheet/XScenariosSupplier.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetAnnotationsSupplier_idl__ +#include <com/sun/star/sheet/XSheetAnnotationsSupplier.idl> +#endif + +#ifndef __com_sun_star_drawing_XDrawPageSupplier_idl__ +#include <com/sun/star/drawing/XDrawPageSupplier.idl> +#endif + +#ifndef __com_sun_star_table_XTableChartsSupplier_idl__ +#include <com/sun/star/table/XTableChartsSupplier.idl> +#endif + +#ifndef __com_sun_star_sheet_XCellRangeMovement_idl__ +#include <com/sun/star/sheet/XCellRangeMovement.idl> +#endif + +#ifndef __com_sun_star_sheet_XPrintAreas_idl__ +#include <com/sun/star/sheet/XPrintAreas.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetPageBreak_idl__ +#include <com/sun/star/sheet/XSheetPageBreak.idl> +#endif + +#ifndef __com_sun_star_sheet_XScenario_idl__ +#include <com/sun/star/sheet/XScenario.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetOutline_idl__ +#include <com/sun/star/sheet/XSheetOutline.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetAuditing_idl__ +#include <com/sun/star/sheet/XSheetAuditing.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetLinkable_idl__ +#include <com/sun/star/sheet/XSheetLinkable.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a complete spreadsheet in a spreadsheet document. + + <p>This service extents the service SheetCellRange. A spreadsheet is + nothing else than a cell range with extended functionality.</p> + + @see com::sun::star::sheet::SpreadsheetDocument */ service Spreadsheet -{ - // DocMerge: empty anyway - service com::sun::star::sheet::SheetCellRange; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XSpreadsheet; - - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; - - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetPageBreak; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XCellRangeMovement; - - // DocMerge: empty anyway - interface com::sun::star::table::XTableChartsSupplier; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XDataPilotTablesSupplier; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XScenariosSupplier; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetAnnotationsSupplier; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::Spreadsheet::IsVisible +{ + //------------------------------------------------------------------------- + + /** provides functionality for cell range handling. + */ + service com::sun::star::sheet::SheetCellRange; + + //========================================================================= + + /** provides methods to create a cell cursor. + */ + interface com::sun::star::sheet::XSpreadsheet; + + //------------------------------------------------------------------------- + + /** provides accessing the spreadsheet name. + */ + interface com::sun::star::container::XNamed; + + //------------------------------------------------------------------------- + + /** provides methods to protect and unprotect the sheet contents. + */ + interface com::sun::star::util::XProtectable; + + //------------------------------------------------------------------------- + + /** provides access to the collection of DataPilot tables. + */ + interface com::sun::star::sheet::XDataPilotTablesSupplier; + + //------------------------------------------------------------------------- + + /** provides access to the collection of scenarios. + */ + interface com::sun::star::sheet::XScenariosSupplier; + + //------------------------------------------------------------------------- + + /** provides access to the collection of annotations. + */ + interface com::sun::star::sheet::XSheetAnnotationsSupplier; + + //------------------------------------------------------------------------- + + /** provides access to the draw page of this spreadsheet. + */ + interface com::sun::star::drawing::XDrawPageSupplier; + + //------------------------------------------------------------------------- + + /** provides access to the collection of chart objects. + */ + interface com::sun::star::table::XTableChartsSupplier; + + //------------------------------------------------------------------------- + + /** provides methods to move cell ranges inside the spreadsheet or to + other spreadsheets in this document. + */ + interface com::sun::star::sheet::XCellRangeMovement; + + //------------------------------------------------------------------------- + + /** provides access to the print area settings of this sheet. + */ + interface com::sun::star::sheet::XPrintAreas; + + //------------------------------------------------------------------------- + + /** provides access to the page breaks of this sheet. + */ + interface com::sun::star::sheet::XSheetPageBreak; + + //------------------------------------------------------------------------- + + /** provides methods for a scenario sheet. + */ + interface com::sun::star::sheet::XScenario; + + //------------------------------------------------------------------------- + + /** provides access to row and column outline settings. + */ + interface com::sun::star::sheet::XSheetOutline; + + //------------------------------------------------------------------------- + + /** provides access to the auditing (detective) functionality. + */ + interface com::sun::star::sheet::XSheetAuditing; + + //------------------------------------------------------------------------- + + /** provides methods for a linked sheet. + */ + interface com::sun::star::sheet::XSheetLinkable; + + //========================================================================= + /** specifies if the sheet is visible. */ - [readonly, property] boolean IsVisible; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::Spreadsheet::PageStyle + [readonly, property] boolean IsVisible; + + //------------------------------------------------------------------------- + /** specifies the page style of the sheet. */ - [readonly, property] string PageStyle; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:08 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [readonly, property] string PageStyle; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SpreadsheetDocument.idl b/offapi/com/sun/star/sheet/SpreadsheetDocument.idl index cc03ce2e1..07874bc39 100644 --- a/offapi/com/sun/star/sheet/SpreadsheetDocument.idl +++ b/offapi/com/sun/star/sheet/SpreadsheetDocument.idl @@ -2,9 +2,9 @@ * * $RCSfile: SpreadsheetDocument.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: sab $ $Date: 2001-09-28 10:34:00 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,28 +58,71 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SpreadsheetDocument_idl__ #define __com_sun_star_sheet_SpreadsheetDocument_idl__ -#ifndef __com_sun_star_lang_XComponent_idl__ -#include <com/sun/star/lang/XComponent.idl> +#ifndef __com_sun_star_document_OfficeDocument_idl__ +#include <com/sun/star/document/OfficeDocument.idl> +#endif + +#ifndef __com_sun_star_sheet_SpreadsheetDocumentSettings_idl__ +#include <com/sun/star/sheet/SpreadsheetDocumentSettings.idl> +#endif + + +#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__ +#include <com/sun/star/lang/XMultiServiceFactory.idl> #endif #ifndef __com_sun_star_frame_XModel_idl__ #include <com/sun/star/frame/XModel.idl> #endif +#ifndef __com_sun_star_document_XActionLockable_idl__ +#include <com/sun/star/document/XActionLockable.idl> +#endif + +#ifndef __com_sun_star_document_XLinkTargetSupplier_idl__ +#include <com/sun/star/document/XLinkTargetSupplier.idl> +#endif + +#ifndef __com_sun_star_util_XProtectable_idl__ +#include <com/sun/star/util/XProtectable.idl> +#endif + #ifndef __com_sun_star_sheet_XSpreadsheetDocument_idl__ #include <com/sun/star/sheet/XSpreadsheetDocument.idl> #endif +#ifndef __com_sun_star_sheet_XCalculatable_idl__ +#include <com/sun/star/sheet/XCalculatable.idl> +#endif + +#ifndef __com_sun_star_sheet_XDocumentAuditing_idl__ +#include <com/sun/star/sheet/XDocumentAuditing.idl> +#endif + +#ifndef __com_sun_star_sheet_XConsolidatable_idl__ +#include <com/sun/star/sheet/XConsolidatable.idl> +#endif + +#ifndef __com_sun_star_sheet_XGoalSeek_idl__ +#include <com/sun/star/sheet/XGoalSeek.idl> +#endif + +#ifndef __com_sun_star_drawing_XDrawPagesSupplier_idl__ +#include <com/sun/star/drawing/XDrawPagesSupplier.idl> +#endif + +#ifndef __com_sun_star_style_XStyleFamiliesSupplier_idl__ +#include <com/sun/star/style/XStyleFamiliesSupplier.idl> +#endif + #ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__ #include <com/sun/star/util/XNumberFormatsSupplier.idl> #endif -#ifndef __com_sun_star_sheet_SpreadsheetDocumentSettings_idl__ -#include <com/sun/star/sheet/SpreadsheetDocumentSettings.idl> -#endif #ifndef __com_sun_star_sheet_XNamedRanges_idl__ #include <com/sun/star/sheet/XNamedRanges.idl> @@ -101,92 +144,155 @@ #include <com/sun/star/sheet/XAreaLinks.idl> #endif -#ifndef __com_sun_star_document_OfficeDocument_idl__ -#include <com/sun/star/document/OfficeDocument.idl> -#endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SpreadsheetDocument -/** a model component which consists of some - settings and one or more spreadsheets. +/** represents a model component which consists of some settings and + one or more spreadsheets. */ service SpreadsheetDocument { - // DocMerge: empty anyway - interface com::sun::star::lang::XComponent; + //------------------------------------------------------------------------- + + /** common service for all types of documents. + */ + service com::sun::star::document::OfficeDocument; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** contributes spreadsheet document specific properties. + */ + service com::sun::star::sheet::SpreadsheetDocumentSettings; + + //========================================================================= + + /** provides methods to create instances of several spreadsheet + services. + */ + interface com::sun::star::lang::XMultiServiceFactory; + + //------------------------------------------------------------------------- + + /** provides common methods for a document model. + + <p>This interface is derived from + <type scope="com::sun::star::lang">XComponent</type>.</p> + */ interface com::sun::star::frame::XModel; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to control the automatic update of cell contents. + */ + interface com::sun::star::document::XActionLockable; + + //------------------------------------------------------------------------- + + /** provides access to the collection of link targets available in + the document. + */ + interface com::sun::star::document::XLinkTargetSupplier; + + //------------------------------------------------------------------------- + + /** provides methods to protect and unprotect the document. + */ + interface com::sun::star::util::XProtectable; + + //------------------------------------------------------------------------- + + /** provides access to the collection of spreadsheets. + */ interface com::sun::star::sheet::XSpreadsheetDocument; - // DocMerge: empty anyway - interface com::sun::star::util::XNumberFormatsSupplier; + //------------------------------------------------------------------------- - // DocMerge: empty anyway - service com::sun::star::sheet::SpreadsheetDocumentSettings; + /** controls the recalculation settings of the document. + */ + interface com::sun::star::sheet::XCalculatable; - service com::sun::star::document::OfficeDocument; + //------------------------------------------------------------------------- + + /** provides a method to refresh all auditing arrows. + */ + interface com::sun::star::sheet::XDocumentAuditing; + + //------------------------------------------------------------------------- + + /** provides methods to perform a data consolidation. + */ + interface com::sun::star::sheet::XConsolidatable; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocument::NamedRanges - /** contains the collection of named ranges in the - document. + /** provides a method to perform a goal seek. + */ + interface com::sun::star::sheet::XGoalSeek; + + //------------------------------------------------------------------------- + + /** provides access to the collection of draw pages of this document. + */ + interface com::sun::star::drawing::XDrawPagesSupplier; + + //------------------------------------------------------------------------- + + /** provides access to the collection of style families. + + <p>A spreadsheet document contains 2 families of styles: + "PageStyles" and "CellStyles".</p> + */ + interface com::sun::star::style::XStyleFamiliesSupplier; + + //------------------------------------------------------------------------- + + /** provides access to the collection of number formats contained in + the document. + */ + interface com::sun::star::util::XNumberFormatsSupplier; + + //========================================================================= + + /** contains the collection of named ranges in the document. */ [readonly, property] com::sun::star::sheet::XNamedRanges NamedRanges; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocument::DatabaseRanges - /** contains the collection of database ranges in the - document. + /** contains the collection of database ranges in the document. */ [readonly, property] com::sun::star::sheet::XDatabaseRanges DatabaseRanges; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocument::ColumnLabelRanges - /** contains the collection of column label ranges - in the document. + /** contains the collection of column label ranges in the document. */ [readonly, property] com::sun::star::sheet::XLabelRanges ColumnLabelRanges; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocument::RowLabelRanges - /** contains the collection of row label ranges - in the document. + /** contains the collection of row label ranges in the document. */ [readonly, property] com::sun::star::sheet::XLabelRanges RowLabelRanges; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocument::SheetLinks - /** contains the collection of sheet links - in the document. + /** contains the collection of sheet links in the document. */ [readonly, property] com::sun::star::container::XNameAccess SheetLinks; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocument::AreaLinks - /** contains the collection of area links - in the document. + /** contains the collection of area links in the document. */ [readonly, property] com::sun::star::sheet::XAreaLinks AreaLinks; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocument::DDELinks - /** contains the collection of DDE links - in the document. + /** contains the collection of DDE links in the document. */ [readonly, property] com::sun::star::container::XNameAccess DDELinks; @@ -196,27 +302,5 @@ service SpreadsheetDocument }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/10 09:02:36 mi - #78530# SpreadsheetDocument exports XNumberFormatsSupplier instead of XNumberFormatter - - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.4 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.2 1999/11/18 11:49:58 mi - XComponent now in module lang - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl b/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl index c1f243cf4..83862748a 100644 --- a/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl +++ b/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: SpreadsheetDocumentSettings.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SpreadsheetDocumentSettings_idl__ #define __com_sun_star_sheet_SpreadsheetDocumentSettings_idl__ @@ -73,167 +74,164 @@ #include <com/sun/star/i18n/XForbiddenCharacters.idl> #endif +#ifndef __com_sun_star_lang_Locale_idl__ +#include <com/sun/star/lang/Locale.idl> +#endif + //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SpreadsheetDocumentSettings -/** keep the configuration - which is global for all views of a spreadsheet document. +/** contributes properties to control the configuration which is global + for all views of a spreadsheet document. + + @see com::sun::star::sheet::SpreadsheetDocument */ service SpreadsheetDocumentSettings { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- + //========================================================================= - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::IsIterationEnabled /** enables iterated calculation of circular references. */ [property] boolean IsIterationEnabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::IterationCount - /** specifies how many iterations are carried out if - iteration is enabled. + /** specifies how many iterations are carried out. + + <p>This setting is only used, if iteration is enabled using + <member>SpreadsheetDocumentSettings::IsIterationEnabled</member>.</p> */ [property] long IterationCount; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::IterationEpsilon - /** if iteration is enabled, this property specifies the point at - which a change in results will stop the iteration. - - + /** specifies the point at which a change in results will stop + the iteration. <p>More exactly it specifies a difference in the change of the result between two iterations. If the result difference is less than or equal to this epsilon-value, the iteration - is stopped. + is stopped.</p> - </p> - <p>only applied when iteration is enabled by + <p>This setting is only used, if iteration is enabled using <member>SpreadsheetDocumentSettings::IsIterationEnabled</member>.</p> */ [property] double IterationEpsilon; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::StandardDecimals - /** specifies the number of decimals in the default - number format. + /** specifies the number of decimals in the default number format. */ [property] short StandardDecimals; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::NullDate - /** specifies the date that is represented by the value - zero. + /** specifies the date that is represented by the value zero. */ [property] com::sun::star::util::Date NullDate; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::DefaultTabStop /** specifies the width of default tabulators. */ [property] short DefaultTabStop; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::IgnoreCase - /** specifies if upper and lower cases are treated as equal + /** specifies whether upper and lower cases are treated as equal when comparing cells. */ [property] boolean IgnoreCase; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::CalcAsShown - /** if this property is set, calculations are performed with the rounded - values displayed in cells instead of the internal values. + /** specifies whether calculations are performed with the rounded + values displayed in cells (set to <TRUE/>) instead of the + internal values (set to <FALSE/>). */ [property] boolean CalcAsShown; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::MatchWholeCell - /** if this property is set, filter criteria must match entire cell - contents. + /** specifies whether filter criteria must match entire cell contents. */ [property] boolean MatchWholeCell; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::SpellOnline /** enables online spell checking. */ [property] boolean SpellOnline; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::LookUpLabels - /** if this property is set, column or row labels are looked up from + /** specifies whether column or row labels are looked up from anywhere on the sheet. + + <p>Explicitly defined label ranges are used even if this property + is set to <FALSE/>.</p> + + @see com::sun::star::sheet::LabelRanges */ [property] boolean LookUpLabels; //------------------------------------------------------------------------- - /** if this property is set, regular expressions in formulas are enabled, + /** specifies whether regular expressions in formulas are enabled, e.g., for functions which look up spreadsheet contents. */ [property] boolean RegularExpressions; //------------------------------------------------------------------------- - /** This property gives the XForbiddenCharacters. + /** contains the interface XForbiddenCharacters. */ - [readonly, property] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters; + [readonly, optional, property] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters; //------------------------------------------------------------------------- - /** If this property is set the document has DrawPages. Use this property - to find out, whether the document has DrawPages or not, because the - getDrawPage method on the XDrawPageSupplier and the getDrawPages method - on the XDrawPagesSupplier always creates the DrawPages - if there are none; and this is very slow and needs more memory. + /** If this property is set the document has DrawPages. Use this + property to find out, whether the document has DrawPages or not, + because the getDrawPage method on the XDrawPageSupplier and the + getDrawPages method on the XDrawPagesSupplier always creates the + DrawPages if there are none; and this is very slow and needs more + memory. */ - [readonly, property] boolean HasDrawPages; + [readonly, optional, property] boolean HasDrawPages; -}; - -//============================================================================= + //------------------------------------------------------------------------- -}; }; }; }; + /** contains the standard document language for Western text. + */ + [optional, property] com::sun::star::lang::Locale CharLocale; -/*============================================================================= + //------------------------------------------------------------------------- - $Log: not supported by cvs2svn $ - Revision 1.5 2001/07/26 07:01:04 sab - #90139#; property HasDrawPages and ForbiddenCharacters added - - Revision 1.4 2001/05/15 18:09:59 er - #78323# new document settings property RegularExpressions + /** contains the standard document language for Asian text. + */ + [optional, property] com::sun::star::lang::Locale CharLocaleAsian; - Revision 1.3 2000/11/08 12:43:46 mi - moved from api + //------------------------------------------------------------------------- - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import + /** contains the standard document language for Complex text. + */ + [optional, property] com::sun::star::lang::Locale CharLocaleComplex; - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SpreadsheetView.idl b/offapi/com/sun/star/sheet/SpreadsheetView.idl index 3a6c5ba26..642faa1f6 100644 --- a/offapi/com/sun/star/sheet/SpreadsheetView.idl +++ b/offapi/com/sun/star/sheet/SpreadsheetView.idl @@ -2,9 +2,9 @@ * * $RCSfile: SpreadsheetView.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: nn $ $Date: 2001-01-10 11:26:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,84 +58,114 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_SpreadsheetView_idl__ -#define __com_sun_star_sheet_SpreadsheetView_idl__ - -#ifndef __com_sun_star_sheet_SpreadsheetViewSettings_idl__ -#include <com/sun/star/sheet/SpreadsheetViewSettings.idl> -#endif - -#ifndef __com_sun_star_sheet_XSpreadsheetView_idl__ -#include <com/sun/star/sheet/XSpreadsheetView.idl> -#endif - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> -#endif - -#ifndef __com_sun_star_view_XSelectionSupplier_idl__ -#include <com/sun/star/view/XSelectionSupplier.idl> -#endif - -#ifndef __com_sun_star_sheet_XViewSplitable_idl__ -#include <com/sun/star/sheet/XViewSplitable.idl> -#endif - -#ifndef __com_sun_star_sheet_XViewFreezable_idl__ -#include <com/sun/star/sheet/XViewFreezable.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::SpreadsheetView -/** a view of a spreadsheet document. +#ifndef __com_sun_star_sheet_SpreadsheetView_idl__ +#define __com_sun_star_sheet_SpreadsheetView_idl__ + +#ifndef __com_sun_star_frame_Controller_idl__ +#include <com/sun/star/frame/Controller.idl> +#endif + +#ifndef __com_sun_star_sheet_SpreadsheetViewSettings_idl__ +#include <com/sun/star/sheet/SpreadsheetViewSettings.idl> +#endif + +#ifndef __com_sun_star_sheet_SpreadsheetViewPane_idl__ +#include <com/sun/star/sheet/SpreadsheetViewPane.idl> +#endif + +#ifndef __com_sun_star_sheet_XSpreadsheetView_idl__ +#include <com/sun/star/sheet/XSpreadsheetView.idl> +#endif + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +#ifndef __com_sun_star_view_XSelectionSupplier_idl__ +#include <com/sun/star/view/XSelectionSupplier.idl> +#endif + +#ifndef __com_sun_star_sheet_XViewSplitable_idl__ +#include <com/sun/star/sheet/XViewSplitable.idl> +#endif + +#ifndef __com_sun_star_sheet_XViewFreezable_idl__ +#include <com/sun/star/sheet/XViewFreezable.idl> +#endif + +#ifndef __com_sun_star_sheet_XRangeSelection_idl__ +#include <com/sun/star/sheet/XRangeSelection.idl> +#endif + +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a view of a spreadsheet document. */ service SpreadsheetView -{ - // DocMerge: empty anyway - service com::sun::star::sheet::SpreadsheetViewSettings; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XSpreadsheetView; - - // DocMerge: empty anyway - interface com::sun::star::container::XIndexAccess; - - // DocMerge: empty anyway - interface com::sun::star::view::XSelectionSupplier; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XViewSplitable; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XViewFreezable; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + /** provides the integration into the framework. + */ + service com::sun::star::frame::Controller; + + /** provides the view's settings. + */ + service com::sun::star::sheet::SpreadsheetViewSettings; + + /** provides direct access to the view's active pane. + */ + service com::sun::star::sheet::SpreadsheetViewPane; + + /** provides access to the active sheet in the view. + */ + interface com::sun::star::sheet::XSpreadsheetView; + + /** provides access to the collection of view panes. + */ + interface com::sun::star::container::XIndexAccess; + + /** creates an enumeration of view panes. + + @see com::sun::star::sheet::SpreadsheetViewPanesEnumeration + + */ + interface com::sun::star::container::XEnumerationAccess; + + /** provides access to the view's selection. + <p>The selection in a spreadsheet view can be a + <type scope="com::sun::star::sheet">SheetCell</type>, + <type scope="com::sun::star::sheet">SheetCellRange</type>, + <type scope="com::sun::star::sheet">SheetCellRanges</type>, + <type scope="com::sun::star::drawing">Shape</type> or + <type scope="com::sun::star::drawing">Shapes</type> object. + </p> + */ + interface com::sun::star::view::XSelectionSupplier; + + /** allows to split the view. + */ + interface com::sun::star::sheet::XViewSplitable; + + /** allows to freeze columns and rows of the view. + */ + interface com::sun::star::sheet::XViewFreezable; + + /** allows to let the user interactively select a cell range. + */ + interface com::sun::star::sheet::XRangeSelection; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SpreadsheetViewPane.idl b/offapi/com/sun/star/sheet/SpreadsheetViewPane.idl index 1638e4cca..a4d23d1e5 100644 --- a/offapi/com/sun/star/sheet/SpreadsheetViewPane.idl +++ b/offapi/com/sun/star/sheet/SpreadsheetViewPane.idl @@ -2,9 +2,9 @@ * * $RCSfile: SpreadsheetViewPane.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,6 +69,10 @@ #include <com/sun/star/sheet/XCellRangeReferrer.idl> #endif +#ifndef __com_sun_star_view_XControlAccess_idl__ +#include <com/sun/star/view/XControlAccess.idl> +#endif + //============================================================================= @@ -76,35 +80,26 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SpreadsheetViewPane -/** a single pane in a view of a spreadsheet document. +/** represents a single pane in a view of a spreadsheet document. */ service SpreadsheetViewPane { - // DocMerge: empty anyway + /** allows to control which cells are shown in the view pane. + */ interface com::sun::star::sheet::XViewPane; - // DocMerge: empty anyway + /** gives direct access to the cell range object for the visible range. + */ interface com::sun::star::sheet::XCellRangeReferrer; + /** provides access to a control model's control for the view pane. + */ + [optional] interface com::sun::star::view::XControlAccess; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +#endif + diff --git a/offapi/com/sun/star/sheet/SpreadsheetViewPanesEnumeration.idl b/offapi/com/sun/star/sheet/SpreadsheetViewPanesEnumeration.idl new file mode 100644 index 000000000..168a1ed73 --- /dev/null +++ b/offapi/com/sun/star/sheet/SpreadsheetViewPanesEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: SpreadsheetViewPanesEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:02 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_SpreadsheetViewPanesEnumeration_idl__ +#define __com_sun_star_sheet_SpreadsheetViewPanesEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of spreadsheet view panes. + + @see com::sun::star::sheet::SpreadsheetViewPane + */ +service SpreadsheetViewPanesEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the spreadsheet view panes in the enumeration. + + @see com::sun::star::sheet::SpreadsheetViewPane + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SpreadsheetViewSettings.idl b/offapi/com/sun/star/sheet/SpreadsheetViewSettings.idl index 5d91d36d8..21ed9a109 100644 --- a/offapi/com/sun/star/sheet/SpreadsheetViewSettings.idl +++ b/offapi/com/sun/star/sheet/SpreadsheetViewSettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: SpreadsheetViewSettings.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: sab $ $Date: 2002-10-02 14:50:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,168 +58,148 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_SpreadsheetViewSettings_idl__ -#define __com_sun_star_sheet_SpreadsheetViewSettings_idl__ -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::SpreadsheetViewSettings -/** settings which are specific to each view of a spreadsheet - document. +#ifndef __com_sun_star_sheet_SpreadsheetViewSettings_idl__ +#define __com_sun_star_sheet_SpreadsheetViewSettings_idl__ + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** contains settings which are specific to each view of a spreadsheet */ service SpreadsheetViewSettings -{ - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowFormulas - /** if this property is set, formulas are displayed instead of their +{ + /** provides access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + //------------------------------------------------------------------------- + + /** controls whether formulas are displayed instead of their results. */ - [property] boolean ShowFormulas; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowZeroValues + [property] boolean ShowFormulas; + + //------------------------------------------------------------------------- + /** enables display of zero-values. */ - [property] boolean ShowZeroValues; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::IsValueHighlightingEnabled - /** if this property is set, strings, values, and formulas are + [property] boolean ShowZeroValues; + + //------------------------------------------------------------------------- + + /** controls whether strings, values, and formulas are displayed in different colors. */ - [property] boolean IsValueHighlightingEnabled; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowNotes - /** if this property is set, a marker is shown for notes in cells. + [property] boolean IsValueHighlightingEnabled; + + //------------------------------------------------------------------------- + + /** controls whether a marker is shown for notes in cells. */ - [property] boolean ShowNotes; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::HasVerticalScrollBar + [property] boolean ShowNotes; + + //------------------------------------------------------------------------- + /** enables the vertical scroll bar of the view. */ - [property] boolean HasVerticalScrollBar; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::HasHorizontalScrollBar + [property] boolean HasVerticalScrollBar; + + //------------------------------------------------------------------------- + /** enables the horizontal scroll bar of the view. */ - [property] boolean HasHorizontalScrollBar; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::HasSheetTabs + [property] boolean HasHorizontalScrollBar; + + //------------------------------------------------------------------------- + /** enables the sheet tabs of the view. */ - [property] boolean HasSheetTabs; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::IsOutlineSymbolsSet + [property] boolean HasSheetTabs; + + //------------------------------------------------------------------------- + /** enables the display of outline symbols. */ - [property] boolean IsOutlineSymbolsSet; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::HasColumnRowHeaders + [property] boolean IsOutlineSymbolsSet; + + //------------------------------------------------------------------------- + /** enables the column and row headers of the view. */ - [property] boolean HasColumnRowHeaders; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowGrid + [property] boolean HasColumnRowHeaders; + + //------------------------------------------------------------------------- + /** enables the display of the cell grid. */ - [property] boolean ShowGrid; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::GridColor + [property] boolean ShowGrid; + + //------------------------------------------------------------------------- + /** specifies the color in which the cell grid is displayed. */ - [property] long GridColor; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowHelpLines + [property] long GridColor; + + //------------------------------------------------------------------------- + /** enables display of help lines when moving drawing objects. */ - [property] boolean ShowHelpLines; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowAnchor + [property] boolean ShowHelpLines; + + //------------------------------------------------------------------------- + /** enables display of anchor symbols when drawing objects are selected. */ - [property] boolean ShowAnchor; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowPageBreaks + [property] boolean ShowAnchor; + + //------------------------------------------------------------------------- + /** enables display of page breaks. */ - [property] boolean ShowPageBreaks; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::SolidHandles + [property] boolean ShowPageBreaks; + + //------------------------------------------------------------------------- + /** enables solid (colored) handles when drawing objects are selected. */ - [property] boolean SolidHandles; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowObjects + [property] boolean SolidHandles; + + //------------------------------------------------------------------------- + /** enables display of embedded objects in the view. */ - [property] short ShowObjects; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowCharts + [property] short ShowObjects; + + //------------------------------------------------------------------------- + /** enables the display of charts in the view. */ - [property] short ShowCharts; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowDrawing + [property] short ShowCharts; + + //------------------------------------------------------------------------- + /** enables the display of drawing objects in the view. */ - [property] short ShowDrawing; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::HideSpellMarks + [property] short ShowDrawing; + + //------------------------------------------------------------------------- + /** disables the display of marks from online spelling. */ - [property] boolean HideSpellMarks; - + [property] boolean HideSpellMarks; + //------------------------------------------------------------------------- /** This property defines the zoom type for the document. @@ -233,28 +213,11 @@ service SpreadsheetViewSettings <member scope="com::sun::star::view::DocumentZoomType">BY_VALUE</member>. */ [property] short ZoomValue; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ +}; + +//============================================================================= + +}; }; }; }; + #endif + diff --git a/offapi/com/sun/star/sheet/Spreadsheets.idl b/offapi/com/sun/star/sheet/Spreadsheets.idl index b116a1e9b..eeec4683d 100644 --- a/offapi/com/sun/star/sheet/Spreadsheets.idl +++ b/offapi/com/sun/star/sheet/Spreadsheets.idl @@ -2,9 +2,9 @@ * * $RCSfile: Spreadsheets.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,60 +58,64 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_Spreadsheets_idl__ -#define __com_sun_star_sheet_Spreadsheets_idl__ - -#ifndef __com_sun_star_sheet_XSpreadsheets_idl__ -#include <com/sun/star/sheet/XSpreadsheets.idl> -#endif - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> -#endif - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::Spreadsheets -/** the collection of spreadsheets in a spreadsheet document. + +#ifndef __com_sun_star_sheet_Spreadsheets_idl__ +#define __com_sun_star_sheet_Spreadsheets_idl__ + +#ifndef __com_sun_star_sheet_XSpreadsheets_idl__ +#include <com/sun/star/sheet/XSpreadsheets.idl> +#endif + +#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 + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents the collection of spreadsheets in a spreadsheet document. + + @see com::sun::star::sheet::SpreadsheetDocument */ service Spreadsheets -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XSpreadsheets; - - // DocMerge: empty anyway - interface com::sun::star::container::XIndexAccess; - - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides methods to access the spreadsheets by name and to insert, + copy, remove and rearrange spreadsheets. + + @see com::sun::star::sheet::Spreadsheet + */ + interface com::sun::star::sheet::XSpreadsheets; + + //------------------------------------------------------------------------- + + /** provides methods to access the spreadsheets by index. + + @see com::sun::star::sheet::Spreadsheet + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all spreadsheets. + + @see com::sun::star::sheet::SpreadsheetsEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SpreadsheetsEnumeration.idl b/offapi/com/sun/star/sheet/SpreadsheetsEnumeration.idl new file mode 100644 index 000000000..2f1da05b8 --- /dev/null +++ b/offapi/com/sun/star/sheet/SpreadsheetsEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: SpreadsheetsEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:03 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_SpreadsheetsEnumeration_idl__ +#define __com_sun_star_sheet_SpreadsheetsEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of spreadsheets in a spreadsheet document. + + @see com::sun::star::sheet::Spreadsheets + */ +service SpreadsheetsEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the spreadsheets in the enumeration. + + @see com::sun::star::sheet::Spreadsheet + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/StatusBarFunction.idl b/offapi/com/sun/star/sheet/StatusBarFunction.idl new file mode 100644 index 000000000..2d31d164c --- /dev/null +++ b/offapi/com/sun/star/sheet/StatusBarFunction.idl @@ -0,0 +1,125 @@ +/************************************************************************* + * + * $RCSfile: StatusBarFunction.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:03 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_StatusBarFunction_idl__ +#define __com_sun_star_sheet_StatusBarFunction_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to specify the function used to calculate a result in the + spreadsheet's status bar. + */ +constants StatusBarFunction +{ + //------------------------------------------------------------------------- + + /** nothing is calculated. + */ + const short NONE = 0; + + //------------------------------------------------------------------------- + + /** average of all numerical values is calculated. + */ + const short AVERAGE = 1; + + //------------------------------------------------------------------------- + + /** all values, including non-numerical values, are counted. + */ + const short COUNTNUMS = 2; + + //------------------------------------------------------------------------- + + /** numerical values are counted. + */ + const short COUNT = 3; + + //------------------------------------------------------------------------- + + /** maximum value of all numerical values is calculated. + */ + const short MAX = 4; + + //------------------------------------------------------------------------- + + /** minimum value of all numerical values is calculated. + */ + const short MIN = 5; + + //------------------------------------------------------------------------- + + /** sum of all numerical values is calculated. + */ + const short SUM = 9; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SubTotalColumn.idl b/offapi/com/sun/star/sheet/SubTotalColumn.idl index 9c1790222..f793bcd00 100644 --- a/offapi/com/sun/star/sheet/SubTotalColumn.idl +++ b/offapi/com/sun/star/sheet/SubTotalColumn.idl @@ -2,9 +2,9 @@ * * $RCSfile: SubTotalColumn.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,56 +58,43 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_SubTotalColumn_idl__ -#define __com_sun_star_sheet_SubTotalColumn_idl__ - -#ifndef __com_sun_star_sheet_GeneralFunction_idl__ -#include <com/sun/star/sheet/GeneralFunction.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: struct com::sun::star::sheet::SubTotalColumn -/** describes how a single data column is treated when - creating subtotals. + +#ifndef __com_sun_star_sheet_SubTotalColumn_idl__ +#define __com_sun_star_sheet_SubTotalColumn_idl__ + +#ifndef __com_sun_star_sheet_GeneralFunction_idl__ +#include <com/sun/star/sheet/GeneralFunction.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** describes how a single data column is treated when creating subtotals. + + @see com::sun::star::sheet::SubTotalDescriptor */ struct SubTotalColumn { - // DocMerge from xml: field com::sun::star::sheet::SubTotalColumn::Column - /** the index of the column. + //------------------------------------------------------------------------- + + /** the index of the column inside the source data area. */ - long Column; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::sheet::SubTotalColumn::Function - /** what kind of subtotals are calculated. + long Column; + + //------------------------------------------------------------------------- + + /** specifies what kind of subtotals are calculated. */ - com::sun::star::sheet::GeneralFunction Function; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::sheet::GeneralFunction Function; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SubTotalDescriptor.idl b/offapi/com/sun/star/sheet/SubTotalDescriptor.idl index e7cf0aa52..1a482562c 100644 --- a/offapi/com/sun/star/sheet/SubTotalDescriptor.idl +++ b/offapi/com/sun/star/sheet/SubTotalDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: SubTotalDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,123 +58,127 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_SubTotalDescriptor_idl__ -#define __com_sun_star_sheet_SubTotalDescriptor_idl__ - -#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__ -#include <com/sun/star/sheet/XSubTotalDescriptor.idl> -#endif - -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::SubTotalDescriptor -/** This is a description of how subtotals are created. + +#ifndef __com_sun_star_sheet_SubTotalDescriptor_idl__ +#define __com_sun_star_sheet_SubTotalDescriptor_idl__ + +#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__ +#include <com/sun/star/sheet/XSubTotalDescriptor.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a description of how subtotals are created. + + <p>The descriptor contains properties and a collection of subtotal fields + which control the behaviour of operation.</p> */ service SubTotalDescriptor -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XSubTotalDescriptor; - - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SubTotalDescriptor::InsertPageBreaks - - // DocMerge from xml: property com::sun::star::sheet::SubTotalDescriptor::InsertPageBreaks +{ + //------------------------------------------------------------------------- + + /** provides access to the collection of subtotal fields. + */ + interface com::sun::star::sheet::XSubTotalDescriptor; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all sub total fields. + + @see com::sun::star::sheet::SubTotalFieldsEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + + //------------------------------------------------------------------------- + + /** provides access to the sub total fields in the collection via index. + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + +//! service PropertySet + /** procides access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + //========================================================================= + /** specifies if page breaks are inserted after each group change. */ - [property] boolean InsertPageBreaks; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SubTotalDescriptor::IsCaseSensitive - - // DocMerge from xml: property com::sun::star::sheet::SubTotalDescriptor::IsCaseSensitive + [property] boolean InsertPageBreaks; + + //------------------------------------------------------------------------- + /** specifies if the case of letters is important when comparing entries. */ - [property] boolean IsCaseSensitive; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SubTotalDescriptor::EnableUserSortList - - // DocMerge from xml: property com::sun::star::sheet::SubTotalDescriptor::EnableUserSortList + [property] boolean IsCaseSensitive; + + //------------------------------------------------------------------------- + /** specifies if a user defined sorting list is used. */ - [property] boolean EnableUserSortList; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SubTotalDescriptor::UserSortListIndex - - // DocMerge from xml: property com::sun::star::sheet::SubTotalDescriptor::UserSortListIndex + [property] boolean EnableUserSortList; + + //------------------------------------------------------------------------- + /** specifies which user defined sorting list is used. - - - - <p>This is only used if <member>SubTotalDescriptor::EnableUserSortList</member> + + <p>This property is only used if + <member>SubTotalDescriptor::EnableUserSortList</member> is <TRUE/>.</p> */ - [property] long UserSortListIndex; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SubTotalDescriptor::BindFormatsToContent - - // DocMerge from xml: property com::sun::star::sheet::SubTotalDescriptor::BindFormatsToContent - /** specifies if cell formats are moved with the contents - they belong to. + [property] long UserSortListIndex; + + //------------------------------------------------------------------------- + + /** specifies if cell formats are moved with the contents they belong to. + */ + [property] boolean BindFormatsToContent; + + //------------------------------------------------------------------------- + + /** specifies if the contents of the fields will be sorted to groups + while performing a subtotal operation. */ - [property] boolean BindFormatsToContent; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SubTotalDescriptor::SortAscending - /** specifies the sorting order if Sort is set to <TRUE/>. + [property] boolean EnableSort; + + //------------------------------------------------------------------------- + + /** specifies the sorting order if + <member>SubTotalDescriptor::EnableSort</member> is set to <TRUE/>. */ - [property] boolean SortAscending; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::SubTotalDescriptor::MaxFieldCount - /** returns the maximum number of subtotal fields - the descriptor can hold. + [property] boolean SortAscending; + + //------------------------------------------------------------------------- + + /** returns the maximum number of subtotal fields the descriptor can + hold. + + <p>This read-only property indicates the maximum count of fields the + current implementation supports.</p> */ - [readonly, property] long MaxFieldCount; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.5 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [readonly, property] long MaxFieldCount; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SubTotalField.idl b/offapi/com/sun/star/sheet/SubTotalField.idl index d2efc1fb9..f69eccbb6 100644 --- a/offapi/com/sun/star/sheet/SubTotalField.idl +++ b/offapi/com/sun/star/sheet/SubTotalField.idl @@ -2,9 +2,9 @@ * * $RCSfile: SubTotalField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,40 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_SubTotalField_idl__ -#define __com_sun_star_sheet_SubTotalField_idl__ - -#ifndef __com_sun_star_sheet_XSubTotalField_idl__ -#include <com/sun/star/sheet/XSubTotalField.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::SubTotalField -/** a single field in a SubTotalDescriptor. + +#ifndef __com_sun_star_sheet_SubTotalField_idl__ +#define __com_sun_star_sheet_SubTotalField_idl__ + +#ifndef __com_sun_star_sheet_XSubTotalField_idl__ +#include <com/sun/star/sheet/XSubTotalField.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a single field in a subtotal descriptor. + + <p>A subtotal field contains all columns for which subtotal values + will be calculated and the column used to create subtotal groups. + + @see com::sun::star::sheet::SubTotalDescriptor */ service SubTotalField -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XSubTotalField; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides access to the settings of the subtotal field. + */ + interface com::sun::star::sheet::XSubTotalField; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SubTotalFieldsEnumeration.idl b/offapi/com/sun/star/sheet/SubTotalFieldsEnumeration.idl new file mode 100644 index 000000000..7a40f3937 --- /dev/null +++ b/offapi/com/sun/star/sheet/SubTotalFieldsEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: SubTotalFieldsEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:04 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_SubTotalFieldsEnumeration_idl__ +#define __com_sun_star_sheet_SubTotalFieldsEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of sub total fields. + + @see com::sun::star::sheet::SubTotalField + */ +service SubTotalFieldsEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the sub total fields in the enumeration. + + @see com::sun::star::sheet::SubTotalField + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableAutoFormat.idl b/offapi/com/sun/star/sheet/TableAutoFormat.idl index dd4ff3077..d7a501f99 100644 --- a/offapi/com/sun/star/sheet/TableAutoFormat.idl +++ b/offapi/com/sun/star/sheet/TableAutoFormat.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableAutoFormat.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,117 +58,118 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_TableAutoFormat_idl__ -#define __com_sun_star_sheet_TableAutoFormat_idl__ - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> -#endif - -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::TableAutoFormat -/** an autoformat for tables. + +#ifndef __com_sun_star_sheet_TableAutoFormat_idl__ +#define __com_sun_star_sheet_TableAutoFormat_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_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an AutoFormat, containing exactly 16 AutoFormat fields. + + <p>Each of the 16 fields contain formatting properties for a table + cell at a specific position in the AutoFormat range. The rows of the + range are divided into a header row, a footer row and 2 data rows + (repeated in turn between header and footer row). The columns are + divided similar. This results in 16 different types of cells in the + range. The AutoFormats are numbered row by row, then column by column.</p> + + @see com::sun::star::sheet::TableAutoFormatField */ service TableAutoFormat -{ - // DocMerge: empty anyway - interface com::sun::star::container::XIndexAccess; - - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; - - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR TableAutoFormat::IncludeFont - - // DocMerge from xml: property com::sun::star::sheet::TableAutoFormat::IncludeFont - /** specifies if the font settings from the fields should be used. +{ + //------------------------------------------------------------------------- + +//! service com::sun::star::beans::PropertySet; + /** provides access to the properties. */ - [property] boolean IncludeFont; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR TableAutoFormat::IncludeJustify - - // DocMerge from xml: property com::sun::star::sheet::TableAutoFormat::IncludeJustify - /** specifies if the justification settings from the fields - should be used. + interface com::sun::star::beans::XPropertySet; + + //========================================================================= + + /** provides methods to access the AutoFormat fields via index. + + @see com::sun::star::sheet::TableAutoFormatField */ - [property] boolean IncludeJustify; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR TableAutoFormat::IncludeBorder - - // DocMerge from xml: property com::sun::star::sheet::TableAutoFormat::IncludeBorder - /** specifies if the border settings from the fields should be used. + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all 16 AutoFormat fields. + + @see com::sun::star::sheet::TableAutoFormatEnumeration */ - [property] boolean IncludeBorder; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR TableAutoFormat::IncludeBackground - - // DocMerge from xml: property com::sun::star::sheet::TableAutoFormat::IncludeBackground - /** specifies if the background settings from the fields should be used. + interface com::sun::star::container::XEnumerationAccess; + + //------------------------------------------------------------------------- + + /** provides methods to access the name of the AutoFormat. */ - [property] boolean IncludeBackground; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR TableAutoFormat::IncludeNumberFormat - - // DocMerge from xml: property com::sun::star::sheet::TableAutoFormat::IncludeNumberFormat - /** specifies if the number format settings from the fields - should be used. + interface com::sun::star::container::XNamed; + + //========================================================================= + + /** specifies whether the font settings from the fields are used. */ - [property] boolean IncludeNumberFormat; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR TableAutoFormat::IncludeWidthAndHeight - - // DocMerge from xml: property com::sun::star::sheet::TableAutoFormat::IncludeWidthAndHeight - /** specifies if the column widths and row heights should be updated - after applying the format. + [property] boolean IncludeFont; + + //------------------------------------------------------------------------- + + /** specifies whether the justification settings from the fields + are used. */ - [property] boolean IncludeWidthAndHeight; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.5 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [property] boolean IncludeJustify; + + //------------------------------------------------------------------------- + + /** specifies whether the border settings from the fields are used. + */ + [property] boolean IncludeBorder; + + //------------------------------------------------------------------------- + + /** specifies whether the background settings from the fields are used. + */ + [property] boolean IncludeBackground; + + //------------------------------------------------------------------------- + + /** specifies whether the number format settings from the fields + are used. + */ + [property] boolean IncludeNumberFormat; + + //------------------------------------------------------------------------- + + /** specifies whether the column widths and row heights should be + updated after applying the format. + */ + [property] boolean IncludeWidthAndHeight; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableAutoFormatEnumeration.idl b/offapi/com/sun/star/sheet/TableAutoFormatEnumeration.idl new file mode 100644 index 000000000..851506266 --- /dev/null +++ b/offapi/com/sun/star/sheet/TableAutoFormatEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: TableAutoFormatEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:04 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_TableAutoFormatEnumeration_idl__ +#define __com_sun_star_sheet_TableAutoFormatEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of AutoFormat fields in an AutoFormat. + + @see com::sun::star::sheet::TableAutoFormat + */ +service TableAutoFormatEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the AutoFormat fields in the enumeration. + + @see com::sun::star::sheet::TableAutoFormatField + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableAutoFormatField.idl b/offapi/com/sun/star/sheet/TableAutoFormatField.idl index 812a0dfda..0603167e3 100644 --- a/offapi/com/sun/star/sheet/TableAutoFormatField.idl +++ b/offapi/com/sun/star/sheet/TableAutoFormatField.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableAutoFormatField.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: dr $ $Date: 2001-11-14 15:11:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_TableAutoFormatField_idl__ #define __com_sun_star_sheet_TableAutoFormatField_idl__ @@ -89,17 +90,22 @@ #include <com/sun/star/table/CellOrientation.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -/** a single field in a TableAutoFormat. +/** represents a field in an AutoFormat. A field contains all cell + properties for a specific position in an AutoFormat. */ service TableAutoFormatField { + //------------------------------------------------------------------------- + +//! service com::sun::star::beans::PropertySet; + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- @@ -252,8 +258,10 @@ service TableAutoFormatField //------------------------------------------------------------------------- - /** is <TRUE/> if the cell background is transparent - and the <member>TableAutoFormatField::CellBackColor</member> value is not used. + /** is <TRUE/> if the cell background is transparent. + + <p>In this case the <member>TableAutoFormatField::CellBackColor</member> + value is not used.</p> */ [property] boolean IsCellBackgroundTransparent; @@ -283,7 +291,8 @@ service TableAutoFormatField //------------------------------------------------------------------------- - /** contains the orientation of the cell contents (i.e. top-to-bottom or stacked). + /** contains the orientation of the cell contents + (i.e. top-to-bottom or stacked). */ [optional, property] com::sun::star::table::CellOrientation Orientation; @@ -301,25 +310,29 @@ service TableAutoFormatField //------------------------------------------------------------------------- - /** contains the margin between cell contents and top border in 1/100 mm. + /** contains the margin between cell contents and top border + (in 1/100 mm). */ [optional, property] long ParaTopMargin; //------------------------------------------------------------------------- - /** contains the margin between cell contents and bottom border in 1/100 mm. + /** contains the margin between cell contents and bottom border + (in 1/100 mm). */ [optional, property] long ParaBottomMargin; //------------------------------------------------------------------------- - /** contains the margin between cell contents and left border in 1/100 mm. + /** contains the margin between cell contents and left border + (in 1/100 mm). */ [optional, property] long ParaLeftMargin; //------------------------------------------------------------------------- - /** contains the margin between cell contents and right border in 1/100 mm. + /** contains the margin between cell contents and right border + (in 1/100 mm). */ [optional, property] long ParaRightMargin; @@ -332,3 +345,4 @@ service TableAutoFormatField //============================================================================= #endif + diff --git a/offapi/com/sun/star/sheet/TableAutoFormats.idl b/offapi/com/sun/star/sheet/TableAutoFormats.idl index d390a884f..7e0607869 100644 --- a/offapi/com/sun/star/sheet/TableAutoFormats.idl +++ b/offapi/com/sun/star/sheet/TableAutoFormats.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableAutoFormats.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,53 +58,62 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_TableAutoFormats_idl__ -#define __com_sun_star_sheet_TableAutoFormats_idl__ - -#ifndef __com_sun_star_container_XNameContainer_idl__ -#include <com/sun/star/container/XNameContainer.idl> -#endif - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::TableAutoFormats -/** a list of table autoformats. + +#ifndef __com_sun_star_sheet_TableAutoFormats_idl__ +#define __com_sun_star_sheet_TableAutoFormats_idl__ + +#ifndef __com_sun_star_container_XNameContainer_idl__ +#include <com/sun/star/container/XNameContainer.idl> +#endif +#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 + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents the collection of AutoFormats. + + <p>There is only one instance of this collection, containing all + AutoFormats usable in spreadsheet and text tables.</p> */ service TableAutoFormats -{ - // DocMerge: empty anyway - interface com::sun::star::container::XNameContainer; - - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides methods to access, insert and remove AutoFormats via name. + + @see com::sun::star::sheet::TableAutoFormat + */ + interface com::sun::star::container::XNameContainer; + + //------------------------------------------------------------------------- + + /** provides methods to access AutoFormats via index. + + @see com::sun::star::sheet::TableAutoFormat + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all AutoFormats. + + @see com::sun::star::sheet::TableAutoFormatEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableAutoFormatsEnumeration.idl b/offapi/com/sun/star/sheet/TableAutoFormatsEnumeration.idl new file mode 100644 index 000000000..9dc872689 --- /dev/null +++ b/offapi/com/sun/star/sheet/TableAutoFormatsEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: TableAutoFormatsEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:05 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_TableAutoFormatsEnumeration_idl__ +#define __com_sun_star_sheet_TableAutoFormatsEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of AutoFormats. + + @see com::sun::star::sheet::TableAutoFormats + */ +service TableAutoFormatsEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the AutoFormats in the enumeration. + + @see com::sun::star::sheet::TableAutoFormat + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableCellStyle.idl b/offapi/com/sun/star/sheet/TableCellStyle.idl new file mode 100644 index 000000000..41d5fc4bd --- /dev/null +++ b/offapi/com/sun/star/sheet/TableCellStyle.idl @@ -0,0 +1,146 @@ +/************************************************************************* + * + * $RCSfile: TableCellStyle.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:06 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_TableCellStyle_idl__ +#define __com_sun_star_sheet_TableCellStyle_idl__ + +#ifndef __com_sun_star_table_CellProperties_idl__ +#include <com/sun/star/table/CellProperties.idl> +#endif + +#ifndef __com_sun_star_style_CellStyle_idl__ +#include <com/sun/star/style/CellStyle.idl> +#endif + +#ifndef __com_sun_star_style_CharacterProperties_idl__ +#include <com/sun/star/style/CharacterProperties.idl> +#endif + +#ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__ +#include <com/sun/star/style/CharacterPropertiesAsian.idl> +#endif + +#ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__ +#include <com/sun/star/style/CharacterPropertiesComplex.idl> +#endif + +#ifndef __com_sun_star_style_ParagraphProperties_idl__ +#include <com/sun/star/style/ParagraphProperties.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** contains the properties of a table cell style. + + <p>This service extends the service + <type scope="com::sun::star::style">CellStyle</type> with spreadsheet + specific properties.</p> + */ +service TableCellStyle +{ + //------------------------------------------------------------------------- + + /** contributes cell specific properties. + */ + service com::sun::star::table::CellProperties; + + //------------------------------------------------------------------------- + + /** is the base service for table cells. + */ + service com::sun::star::style::CellStyle; + + //------------------------------------------------------------------------- + + /** 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; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableConditionalEntry.idl b/offapi/com/sun/star/sheet/TableConditionalEntry.idl index bd009984f..8ba0901da 100644 --- a/offapi/com/sun/star/sheet/TableConditionalEntry.idl +++ b/offapi/com/sun/star/sheet/TableConditionalEntry.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableConditionalEntry.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,53 +58,47 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_TableConditionalEntry_idl__ -#define __com_sun_star_sheet_TableConditionalEntry_idl__ - -#ifndef __com_sun_star_sheet_XSheetCondition_idl__ -#include <com/sun/star/sheet/XSheetCondition.idl> -#endif - -#ifndef __com_sun_star_sheet_XSheetConditionalEntry_idl__ -#include <com/sun/star/sheet/XSheetConditionalEntry.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::TableConditionalEntry -/** a single entry in a TableConditionalFormat object. + +#ifndef __com_sun_star_sheet_TableConditionalEntry_idl__ +#define __com_sun_star_sheet_TableConditionalEntry_idl__ + +#ifndef __com_sun_star_sheet_XSheetCondition_idl__ +#include <com/sun/star/sheet/XSheetCondition.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetConditionalEntry_idl__ +#include <com/sun/star/sheet/XSheetConditionalEntry.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a single condition in a conditional format. + + @see com::sun::star::sheet::TableConditionalFormat */ service TableConditionalEntry -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetCondition; - - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetConditionalEntry; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides methods to access the settings of this condition. + */ + interface com::sun::star::sheet::XSheetCondition; + + //------------------------------------------------------------------------- + + /** provides methods to access the cell style name for this condition. + */ + interface com::sun::star::sheet::XSheetConditionalEntry; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableConditionalEntryEnumeration.idl b/offapi/com/sun/star/sheet/TableConditionalEntryEnumeration.idl new file mode 100644 index 000000000..4ea01e81a --- /dev/null +++ b/offapi/com/sun/star/sheet/TableConditionalEntryEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: TableConditionalEntryEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:07 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_TableConditionalEntryEnumeration_idl__ +#define __com_sun_star_sheet_TableConditionalEntryEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of conditional entries. + + @see com::sun::star::sheet::TableConditionalEntry + */ +service TableConditionalEntryEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the conditional entries in the enumeration. + + @see com::sun::star::sheet::TableConditionalEntry + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableConditionalFormat.idl b/offapi/com/sun/star/sheet/TableConditionalFormat.idl index 168f033ca..6039209a3 100644 --- a/offapi/com/sun/star/sheet/TableConditionalFormat.idl +++ b/offapi/com/sun/star/sheet/TableConditionalFormat.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableConditionalFormat.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,60 +58,80 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_TableConditionalFormat_idl__ -#define __com_sun_star_sheet_TableConditionalFormat_idl__ - -#ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__ -#include <com/sun/star/sheet/XSheetConditionalEntries.idl> -#endif - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::TableConditionalFormat -/** the conditional formatting for a cell or cell range. + +#ifndef __com_sun_star_sheet_TableConditionalFormat_idl__ +#define __com_sun_star_sheet_TableConditionalFormat_idl__ + +#ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__ +#include <com/sun/star/sheet/XSheetConditionalEntries.idl> +#endif + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of conditional formatting settings for a + cell or cell range. + + <p>The style of the first fulfilled condition (in index order) will + be applied to the cell(s).</p> + + @see com::sun::star::sheet::SheetCell + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SheetCellRanges */ service TableConditionalFormat -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetConditionalEntries; - - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; - - // DocMerge: empty anyway - interface com::sun::star::container::XIndexAccess; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + + /** provides methods to insert and remove conditions and to access + the condition via index. + + @see com::sun::star::sheet::TableConditionalEntry + */ + interface com::sun::star::sheet::XSheetConditionalEntries; + + //------------------------------------------------------------------------- + + /** provides methods to access the condition via name. + + <p>The name of a condition is "Entry", followed by its index + (i.e. Entry0, Entry1, ...).</p> + + @see com::sun::star::sheet::TableConditionalEntry + */ + interface com::sun::star::container::XNameAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all conditional entries. + + @see com::sun::star::sheet::TableConditionalEntryEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + + //------------------------------------------------------------------------- + + /** provides methods to access the contained conditional entries by index. + + @see com::sun::star::sheet::TableConditionalEntry + */ + interface com::sun::star::container::XIndexAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableFilterField.idl b/offapi/com/sun/star/sheet/TableFilterField.idl index 7b366b2a9..945352582 100644 --- a/offapi/com/sun/star/sheet/TableFilterField.idl +++ b/offapi/com/sun/star/sheet/TableFilterField.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableFilterField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,95 +58,72 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_TableFilterField_idl__ -#define __com_sun_star_sheet_TableFilterField_idl__ - -#ifndef __com_sun_star_sheet_FilterConnection_idl__ -#include <com/sun/star/sheet/FilterConnection.idl> -#endif - -#ifndef __com_sun_star_sheet_FilterOperator_idl__ -#include <com/sun/star/sheet/FilterOperator.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: struct com::sun::star::sheet::TableFilterField + +#ifndef __com_sun_star_sheet_TableFilterField_idl__ +#define __com_sun_star_sheet_TableFilterField_idl__ + +#ifndef __com_sun_star_sheet_FilterConnection_idl__ +#include <com/sun/star/sheet/FilterConnection.idl> +#endif + +#ifndef __com_sun_star_sheet_FilterOperator_idl__ +#include <com/sun/star/sheet/FilterOperator.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** describes a single condition in a filter descriptor. + + @see com::sun::star::sheet::SheetFilterDescriptor */ struct TableFilterField { - // DocMerge from xml: field com::sun::star::sheet::TableFilterField::Connection - /** specifies how the condition is connected to the previous - condition. + //------------------------------------------------------------------------- + + /** specifies how the condition is connected to the previous condition. */ - com::sun::star::sheet::FilterConnection Connection; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::sheet::TableFilterField::Field + com::sun::star::sheet::FilterConnection Connection; + + //------------------------------------------------------------------------- + /** specifies which field (column) is used for the condition. */ - long Field; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::sheet::TableFilterField::Operator + long Field; + + //------------------------------------------------------------------------- + /** specifies the type of the condition. */ - com::sun::star::sheet::FilterOperator Operator; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::sheet::TableFilterField::IsNumeric - /** selects whether the <member>TableFilterField::NumericValue</member> or the - <member>TableFilterField::StringValue</member> is used. + com::sun::star::sheet::FilterOperator Operator; + + //------------------------------------------------------------------------- + + /** selects whether the <member>TableFilterField::NumericValue</member> + or the <member>TableFilterField::StringValue</member> is used. */ - boolean IsNumeric; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::sheet::TableFilterField::NumericValue + boolean IsNumeric; + + //------------------------------------------------------------------------- + /** specifies a numeric value for the condition. */ - double NumericValue; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::sheet::TableFilterField::StringValue + double NumericValue; + + //------------------------------------------------------------------------- + /** specifies a string value for the condition. */ - string StringValue; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.5 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:09 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + string StringValue; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableOperationMode.idl b/offapi/com/sun/star/sheet/TableOperationMode.idl index 34316ac80..ae0830071 100644 --- a/offapi/com/sun/star/sheet/TableOperationMode.idl +++ b/offapi/com/sun/star/sheet/TableOperationMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableOperationMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,61 +58,53 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_TableOperationMode_idl__ -#define __com_sun_star_sheet_TableOperationMode_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::TableOperationMode + +#ifndef __com_sun_star_sheet_TableOperationMode_idl__ +#define __com_sun_star_sheet_TableOperationMode_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** used to specify if a table operation is applied to columns, rows, or both columns and rows. */ enum TableOperationMode -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::TableOperationMode::COLUMN +{ + //------------------------------------------------------------------------- + /** is applied to the columns. + + <p>In this mode, the column contains values and the row + contains formulas.</p> */ - COLUMN, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::TableOperationMode::ROW + COLUMN, + + //------------------------------------------------------------------------- + /** is applied to the rows. + + <p>In this mode, the row contains values and the column + contains formulas.</p> */ - ROW, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::TableOperationMode::BOTH + ROW, + + //------------------------------------------------------------------------- + /** is applied to rows and columns. + + <p>In this mode, the row and the column contain values. A formula + using both row and column values is specified separately.</p> */ - BOTH - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + BOTH + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TablePageBreakData.idl b/offapi/com/sun/star/sheet/TablePageBreakData.idl index 688238acb..4edf2babb 100644 --- a/offapi/com/sun/star/sheet/TablePageBreakData.idl +++ b/offapi/com/sun/star/sheet/TablePageBreakData.idl @@ -2,9 +2,9 @@ * * $RCSfile: TablePageBreakData.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,55 +58,39 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_TablePageBreakData_idl__ -#define __com_sun_star_sheet_TablePageBreakData_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: struct com::sun::star::sheet::TablePageBreakData -/** describes a page break. + +#ifndef __com_sun_star_sheet_TablePageBreakData_idl__ +#define __com_sun_star_sheet_TablePageBreakData_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** describes a page break in a spreadsheet. + + @see com::sun::star::sheet::XSheetPageBreak */ struct TablePageBreakData { - // DocMerge from xml: field com::sun::star::sheet::TablePageBreakData::Position - /** the position of the page break. + //------------------------------------------------------------------------- + + /** the position (column or row index) of the page break. */ - long Position; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::sheet::TablePageBreakData::ManualBreak - /** is <TRUE/> for a manual page break, - <FALSE/> for an automatic one. + long Position; + + //------------------------------------------------------------------------- + + /** is <TRUE/> for a manual page break, <FALSE/> for an automatic one. */ - boolean ManualBreak; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + boolean ManualBreak; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TablePageStyle.idl b/offapi/com/sun/star/sheet/TablePageStyle.idl index edc8c3af3..70345c113 100644 --- a/offapi/com/sun/star/sheet/TablePageStyle.idl +++ b/offapi/com/sun/star/sheet/TablePageStyle.idl @@ -2,9 +2,9 @@ * * $RCSfile: TablePageStyle.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,280 +58,180 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_TablePageStyle_idl__ -#define __com_sun_star_sheet_TablePageStyle_idl__ - -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - -#ifndef __com_sun_star_table_ShadowFormat_idl__ -#include <com/sun/star/table/ShadowFormat.idl> -#endif - -#ifndef __com_sun_star_sheet_XHeaderFooterContent_idl__ -#include <com/sun/star/sheet/XHeaderFooterContent.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::TablePageStyle -/** a spreadsheet page format. + +#ifndef __com_sun_star_sheet_TablePageStyle_idl__ +#define __com_sun_star_sheet_TablePageStyle_idl__ + +#ifndef __com_sun_star_style_PageStyle_idl__ +#include <com/sun/star/style/PageStyle.idl> +#endif + +#ifndef __com_sun_star_sheet_XHeaderFooterContent_idl__ +#include <com/sun/star/sheet/XHeaderFooterContent.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a page style for a spreadsheet. + + <p>This service extends the service + <type scope="com::sun::star::style">PageStyle</type> with spreadsheet + specific properties.</p> */ service TablePageStyle -{ - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::BackgroundColor - /** contains the value of the page background color. - */ - [property] long BackgroundColor; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::IsBackgroundTransparent - /** is <TRUE/> if the page background is transparent. - */ - [property] boolean IsBackgroundTransparent; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::ShadowFormat - /** contains the description of a shadow for the page. - */ - [property] com::sun::star::table::ShadowFormat ShadowFormat; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::CenterHorizontally - /** if set, the page is centered horizontally. - */ - [property] boolean CenterHorizontally; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::CenterVertically - /** if set, the page is centered vertically. - */ - [property] boolean CenterVertically; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintAnnotations +{ + //------------------------------------------------------------------------- + + /** contains all common page style properties. + */ + service com::sun::star::style::PageStyle; + + //========================================================================= + + /** determines whether the table is centered horizontally on the page. + */ + [property] boolean CenterHorizontally; + + //------------------------------------------------------------------------- + + /** determines whether the table is centered vertically on the page. + */ + [property] boolean CenterVertically; + + //------------------------------------------------------------------------- + /** enables printing of cell annotations. */ - [property] boolean PrintAnnotations; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintGrid + [property] boolean PrintAnnotations; + + //------------------------------------------------------------------------- + /** enables printing of the cell grid. */ - [property] boolean PrintGrid; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintHeaders + [property] boolean PrintGrid; + + //------------------------------------------------------------------------- + /** enables printing of column and row headers. */ - [property] boolean PrintHeaders; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintCharts + [property] boolean PrintHeaders; + + //------------------------------------------------------------------------- + /** enables printing of charts. */ - [property] boolean PrintCharts; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintObjects + [property] boolean PrintCharts; + + //------------------------------------------------------------------------- + /** enables printing of embedded objects. */ - [property] boolean PrintObjects; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintDrawing + [property] boolean PrintObjects; + + //------------------------------------------------------------------------- + /** enables printing of drawing objects. */ - [property] boolean PrintDrawing; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintDownFirst - /** specifies the print order for the pages - within each sheet. - - - - <p>If <TRUE/>, the order for printing pages begins with top-to-bottom, - then continues with the next set of cell columns to the right. If - <FALSE/>, the order for printing pages begins with left-to-right, - then continues with the next set of cell rows to the bottom.</p> - */ - [property] boolean PrintDownFirst; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintFormulas - /** enables printing of formulas instead of their - results. + [property] boolean PrintDrawing; + + //------------------------------------------------------------------------- + + /** enables printing of formulas instead of their results. */ - [property] boolean PrintFormulas; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintZeroValues + [property] boolean PrintFormulas; + + //------------------------------------------------------------------------- + /** enables printing of zero-values. */ - [property] boolean PrintZeroValues; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::LeftPageHeaderContent + [property] boolean PrintZeroValues; + + //------------------------------------------------------------------------- + + /** specifies the print order for the pages within each sheet. + + <p>If <TRUE/>, the order for printing pages begins with + top-to-bottom, then continues with the next set of cell columns + to the right. If <FALSE/>, the order for printing pages begins + with left-to-right, then continues with the next set of cell + rows to the bottom.</p> + */ + [property] boolean PrintDownFirst; + + //------------------------------------------------------------------------- + /** contains the content of the header for left pages. - */ - [property] com::sun::star::sheet::XHeaderFooterContent LeftPageHeaderContent; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::LeftPageFooterContent + + <p>After changing the header text contents, this property has to be + reinserted into the property set.</p> + + @see com::sun::star::sheet::HeaderFooterContent + */ + [property] com::sun::star::sheet::XHeaderFooterContent LeftPageHeaderContent; + + //------------------------------------------------------------------------- + /** contains the content of the footer for left pages. - */ - [property] com::sun::star::sheet::XHeaderFooterContent LeftPageFooterContent; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::RightPageHeaderContent + + <p>After changing the footer text contents, this property has to be + reinserted into the property set.</p> + + @see com::sun::star::sheet::HeaderFooterContent + */ + [property] com::sun::star::sheet::XHeaderFooterContent LeftPageFooterContent; + + //------------------------------------------------------------------------- + /** contains the content of the header for right pages. - */ - [property] com::sun::star::sheet::XHeaderFooterContent RightPageHeaderContent; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::RightPageFooterContent + + <p>After changing the header text contents, this property has to be + reinserted into the property set.</p> + + @see com::sun::star::sheet::HeaderFooterContent + */ + [property] com::sun::star::sheet::XHeaderFooterContent RightPageHeaderContent; + + //------------------------------------------------------------------------- + /** contains the content of the footer for right pages. - */ - [property] com::sun::star::sheet::XHeaderFooterContent RightPageFooterContent; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::HeaderBackgroundColor - /** contains the value of the header background color. - */ - [property] long HeaderBackgroundColor; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::TransparentHeaderBackground - /** is <TRUE/> if the header background is transparent. - */ - [property] boolean TransparentHeaderBackground; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::HeaderShadowFormat - /** contains the description of a shadow for the header. - */ - [property] com::sun::star::table::ShadowFormat HeaderShadowFormat; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::HeaderOn - /** enables printing of page headers. - */ - [property] boolean HeaderOn; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::HeaderDynamic - /** if set, the header height is adjusted for the - contents. - */ - [property] boolean HeaderDynamic; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::HeaderShared - /** if set, header contents are equal for left and - right pages. - */ - [property] boolean HeaderShared; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::FooterBackgroundColor - /** contains the value of the footer background color. - */ - [property] long FooterBackgroundColor; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::TransparentFooterBackground - /** is <TRUE/> if the footer background is transparent. - */ - [property] boolean TransparentFooterBackground; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::FooterShadowFormat - /** contains the description of a shadow for the footer. - */ - [property] com::sun::star::table::ShadowFormat FooterShadowFormat; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::FooterOn - /** enables printing of page footers. - */ - [property] boolean FooterOn; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::FooterDynamic - /** if set, the footer height is adjusted for the - contents. - */ - [property] boolean FooterDynamic; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::FooterShared - /** if set, footer contents are equal for left and - right pages. - */ - [property] boolean FooterShared; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + + <p>After changing the footer text contents, this property has to be + reinserted into the property set.</p> + + @see com::sun::star::sheet::HeaderFooterContent + */ + [property] com::sun::star::sheet::XHeaderFooterContent RightPageFooterContent; + + //------------------------------------------------------------------------- + + /** contains the page number applied to the first page for this sheet. + + <p>The value 0 indicates that the page numbers are continued from + the previous sheet.</p> + */ + [property] short FirstPageNumber; + + //------------------------------------------------------------------------- + + /** contains the scaling factor (in percent) for printing the sheet. + */ + [property] short PageScale; + + //------------------------------------------------------------------------- + + /** contains the number of pages the sheet will printed. + */ + [property] short ScaleToPages; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableValidation.idl b/offapi/com/sun/star/sheet/TableValidation.idl index 57da06071..541460aeb 100644 --- a/offapi/com/sun/star/sheet/TableValidation.idl +++ b/offapi/com/sun/star/sheet/TableValidation.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableValidation.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,162 +58,125 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_TableValidation_idl__ -#define __com_sun_star_sheet_TableValidation_idl__ - -#ifndef __com_sun_star_sheet_XSheetCondition_idl__ -#include <com/sun/star/sheet/XSheetCondition.idl> -#endif - -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - -#ifndef __com_sun_star_sheet_ValidationType_idl__ -#include <com/sun/star/sheet/ValidationType.idl> -#endif - -#ifndef __com_sun_star_sheet_ValidationAlertStyle_idl__ -#include <com/sun/star/sheet/ValidationAlertStyle.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::TableValidation -/** the validation settings for a cell or cell range. + +#ifndef __com_sun_star_sheet_TableValidation_idl__ +#define __com_sun_star_sheet_TableValidation_idl__ + +#ifndef __com_sun_star_sheet_XSheetCondition_idl__ +#include <com/sun/star/sheet/XSheetCondition.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +#ifndef __com_sun_star_sheet_ValidationType_idl__ +#include <com/sun/star/sheet/ValidationType.idl> +#endif + +#ifndef __com_sun_star_sheet_ValidationAlertStyle_idl__ +#include <com/sun/star/sheet/ValidationAlertStyle.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents the data validation settings for a cell or cell range. */ service TableValidation -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetCondition; - - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TableValidation::Type +{ + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + //------------------------------------------------------------------------- + + /** provides access to the settings of the condition. + */ + interface com::sun::star::sheet::XSheetCondition; + + //========================================================================= + /** specifies the type of validation. */ - [property] com::sun::star::sheet::ValidationType Type; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TableValidation::ShowInputMessage - /** specifies if an input message is shown when - the cursor is in a cell with these validation settings. + [property] com::sun::star::sheet::ValidationType Type; + + //------------------------------------------------------------------------- + + /** specifies if an input message is shown when the cursor is in a + cell with these validation settings. */ - [property] boolean ShowInputMessage; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TableValidation::InputTitle - /** specifies the title of the window showing - the input message. - - - + [property] boolean ShowInputMessage; + + //------------------------------------------------------------------------- + + /** specifies the title of the window showing the input message. + <p>This is only used if <member>TableValidation::ShowInputMessage</member> - is <TRUE/>.</p> + is set to <TRUE/>.</p> */ - [property] string InputTitle; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TableValidation::InputMessage + [property] string InputTitle; + + //------------------------------------------------------------------------- + /** specifies the text of the input message. - - - + <p>This is only used if <member>TableValidation::ShowInputMessage</member> - is <TRUE/>.</p> + is set to <TRUE/>.</p> */ - [property] string InputMessage; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TableValidation::ShowErrorMessage - /** specifies if an error message is displayed - when invalid data is entered. + [property] string InputMessage; + + //------------------------------------------------------------------------- + + /** specifies if an error message is displayed when invalid data + is entered. */ - [property] boolean ShowErrorMessage; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TableValidation::ErrorTitle - /** specifies the title of the window showing the - error message. - - - + [property] boolean ShowErrorMessage; + + //------------------------------------------------------------------------- + + /** specifies the title of the window showing the error message. + <p>This is only used if <member>TableValidation::ShowErrorMessage</member> - is <TRUE/>.</p> + is set to <TRUE/>.</p> */ - [property] string ErrorTitle; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TableValidation::ErrorMessage + [property] string ErrorTitle; + + //------------------------------------------------------------------------- + /** specifies the text of the error message. - - - + <p>This is only used if <member>TableValidation::ShowErrorMessage</member> - is <TRUE/>.</p> + is set to <TRUE/>.</p> */ - [property] string ErrorMessage; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TableValidation::IgnoreBlankCells + [property] string ErrorMessage; + + //------------------------------------------------------------------------- + /** specifies if blank cells should be allowed. */ - [property] boolean IgnoreBlankCells; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TableValidation::ErrorAlertStyle + [property] boolean IgnoreBlankCells; + + //------------------------------------------------------------------------- + /** specifies the style of the error message. - - - + <p>This is used only if <member>TableValidation::ShowErrorMessage</member> - is <TRUE/>.</p> + is set to <TRUE/>.</p> */ - [property] com::sun::star::sheet::ValidationAlertStyle ErrorAlertStyle; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.5 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:09 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [property] com::sun::star::sheet::ValidationAlertStyle ErrorAlertStyle; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/UniqueCellFormatRanges.idl b/offapi/com/sun/star/sheet/UniqueCellFormatRanges.idl new file mode 100644 index 000000000..49be61762 --- /dev/null +++ b/offapi/com/sun/star/sheet/UniqueCellFormatRanges.idl @@ -0,0 +1,114 @@ +/************************************************************************* + * + * $RCSfile: UniqueCellFormatRanges.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:10 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_UniqueCellFormatRanges_idl__ +#define __com_sun_star_sheet_UniqueCellFormatRanges_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 + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of equal-formatted cell range collections. + + <p>All cells inside a cell range collection (a member of this + collection) have the same formatting attributes.</p> + + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SheetCellRanges + @see com::sun::star::sheet::CellFormatRanges + */ +service UniqueCellFormatRanges +{ + //------------------------------------------------------------------------- + + /** provides methods to access the contained cell range + collections by index. + + @see com::sun::star::sheet::SheetCellRanges + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all cell range collections. + + @see com::sun::star::sheet::UniqueCellFormatRangesEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/UniqueCellFormatRangesEnumeration.idl b/offapi/com/sun/star/sheet/UniqueCellFormatRangesEnumeration.idl new file mode 100644 index 000000000..39ac44339 --- /dev/null +++ b/offapi/com/sun/star/sheet/UniqueCellFormatRangesEnumeration.idl @@ -0,0 +1,97 @@ +/************************************************************************* + * + * $RCSfile: UniqueCellFormatRangesEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:10 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_UniqueCellFormatRangesEnumeration_idl__ +#define __com_sun_star_sheet_UniqueCellFormatRangesEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of equal-formatted cell range collections. + + @see com::sun::star::sheet::UniqueCellFormatRanges + */ +service UniqueCellFormatRangesEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the cell range collections + in the enumeration. + + @see com::sun::star::sheet::SheetCellRanges + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/ValidationAlertStyle.idl b/offapi/com/sun/star/sheet/ValidationAlertStyle.idl index 48225fdf5..cea536ef7 100644 --- a/offapi/com/sun/star/sheet/ValidationAlertStyle.idl +++ b/offapi/com/sun/star/sheet/ValidationAlertStyle.idl @@ -2,9 +2,9 @@ * * $RCSfile: ValidationAlertStyle.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,69 +58,51 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_ValidationAlertStyle_idl__ -#define __com_sun_star_sheet_ValidationAlertStyle_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::ValidationAlertStyle + +#ifndef __com_sun_star_sheet_ValidationAlertStyle_idl__ +#define __com_sun_star_sheet_ValidationAlertStyle_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** used to specify how invalid cell contents are treated. */ enum ValidationAlertStyle -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ValidationAlertStyle::STOP +{ + //------------------------------------------------------------------------- + /** error message is shown and the change is rejected. */ - STOP, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ValidationAlertStyle::WARNING + STOP, + + //------------------------------------------------------------------------- + /** warning message is shown and the user is asked whether the - change is to be accepted. + change will be accepted (defaulted to "No"). */ - WARNING, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ValidationAlertStyle::INFO + WARNING, + + //------------------------------------------------------------------------- + /** information message is shown and the user is asked whether the - change is to be accepted. + change will be accepted (defaulted to "Yes"). */ - INFO, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ValidationAlertStyle::MACRO + INFO, + + //------------------------------------------------------------------------- + /** macro is executed. */ - MACRO - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + MACRO + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/ValidationType.idl b/offapi/com/sun/star/sheet/ValidationType.idl index aefaa8fed..45dc5fa9b 100644 --- a/offapi/com/sun/star/sheet/ValidationType.idl +++ b/offapi/com/sun/star/sheet/ValidationType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ValidationType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,96 +58,73 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_ValidationType_idl__ -#define __com_sun_star_sheet_ValidationType_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: enum com::sun::star::sheet::ValidationType -/** used to specify which cell contents are treated as - valid. + +#ifndef __com_sun_star_sheet_ValidationType_idl__ +#define __com_sun_star_sheet_ValidationType_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to specify which cell contents are treated as valid. */ enum ValidationType -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ValidationType::ANY +{ + //------------------------------------------------------------------------- + /** any cell content is valid; no conditions are used. */ - ANY, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ValidationType::WHOLE + ANY, + + //------------------------------------------------------------------------- + /** any whole number matching the specified condition is valid. */ - WHOLE, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ValidationType::DECIMAL + WHOLE, + + //------------------------------------------------------------------------- + /** any number matching the specified condition is valid. */ - DECIMAL, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ValidationType::DATE + DECIMAL, + + //------------------------------------------------------------------------- + /** any date value matching the specified condition is valid. */ - DATE, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ValidationType::TIME + DATE, + + //------------------------------------------------------------------------- + /** any time value matching the specified condition is valid. */ - TIME, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ValidationType::TEXT_LEN + TIME, + + //------------------------------------------------------------------------- + /** string is valid if its length matches the specified condition. */ - TEXT_LEN, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ValidationType::LIST + TEXT_LEN, + + //------------------------------------------------------------------------- + /** Only strings from a specified list are valid. */ - LIST, - - //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::sheet::ValidationType::CUSTOM + LIST, + + //------------------------------------------------------------------------- + /** The specified formula detemines which contents are valid. */ - CUSTOM - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + CUSTOM + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/VolatileResult.idl b/offapi/com/sun/star/sheet/VolatileResult.idl index 519b1d61b..ac25b6955 100644 --- a/offapi/com/sun/star/sheet/VolatileResult.idl +++ b/offapi/com/sun/star/sheet/VolatileResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: VolatileResult.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,52 +58,41 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_VolatileResult_idl__ -#define __com_sun_star_sheet_VolatileResult_idl__ - -#ifndef __com_sun_star_sheet_XVolatileResult_idl__ -#include <com/sun/star/sheet/XVolatileResult.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: service com::sun::star::sheet::VolatileResult -/** a volatile result. - - - - <p>A volatile result can change its value over time. - The <type>XVolatileResult</type> interface allows the addition of listeners - which are notified when the value changes.</p> + +#ifndef __com_sun_star_sheet_VolatileResult_idl__ +#define __com_sun_star_sheet_VolatileResult_idl__ + +#ifndef __com_sun_star_sheet_XVolatileResult_idl__ +#include <com/sun/star/sheet/XVolatileResult.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a volatile function result. + + <p>A volatile function result can change its value over time. The + <type>XVolatileResult</type> interface allows the addition of + listeners which are notified when the value changes.</p> + + @see com::sun::star::sheet::AddIn */ service VolatileResult -{ - // DocMerge: empty anyway - interface com::sun::star::sheet::XVolatileResult; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +{ + // ------------------------------------------------------------------------ + + /** porovides handling with a volatile function result. + */ + interface com::sun::star::sheet::XVolatileResult; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XAddIn.idl b/offapi/com/sun/star/sheet/XAddIn.idl index 91c0ac7f1..f415a4d4e 100644 --- a/offapi/com/sun/star/sheet/XAddIn.idl +++ b/offapi/com/sun/star/sheet/XAddIn.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAddIn.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,202 +58,195 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XAddIn_idl__ -#define __com_sun_star_sheet_XAddIn_idl__ - -#ifndef __com_sun_star_lang_XLocalizable_idl__ -#include <com/sun/star/lang/XLocalizable.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XAddIn + +#ifndef __com_sun_star_sheet_XAddIn_idl__ +#define __com_sun_star_sheet_XAddIn_idl__ + +#ifndef __com_sun_star_lang_XLocalizable_idl__ +#include <com/sun/star/lang/XLocalizable.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** gives access to function descriptions and user-visible names. */ interface XAddIn: com::sun::star::lang::XLocalizable -{ - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAddIn::getProgrammaticFuntionName - - // DocMerge from xml: method com::sun::star::sheet::XAddIn::getProgrammaticFuntionName - /** returns the programmatic name for a specified user-visible function - name. - - - - <p>The programmatic name must be the exact name of the method within - its interface.</p> +{ + //------------------------------------------------------------------------- + + /** returns the internal function name for an user-visible name. + + <p>The user-visible name of a function is the name shown to the + user. It may be translated to the current language of the AddIn, + so it is never stored in files. It should be a single word and is + used when entering or displaying formulas.</p> + + <p>Attention: The method name contains a spelling error. Due to + compatibility reasons the name cannot be changed.</p> + + @param aDisplayName + the user-visible name of a function. + + @returns + the exact name of the method within its interface. + */ - string getProgrammaticFuntionName( [in] string aDisplayName ); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAddIn::getDisplayFunctionName - - // DocMerge from xml: method com::sun::star::sheet::XAddIn::getDisplayFunctionName - /** returns the user-visible name of the function. - - - - <p>This is the name for the function that is shown to the user. - It may be translated to the current language of the AddIn, so it - is never stored in files. It should be a single word and is used - when entering or displaying formulas.</p> + string getProgrammaticFuntionName( [in] string aDisplayName ); + + //------------------------------------------------------------------------- + + /** returns the user-visible function name for an internal name. + + <p>The user-visible name of a function is the name shown to the + user. It may be translated to the current language of the AddIn, + so it is never stored in files. It should be a single word and is + used when entering or displaying formulas.</p> + + @param aProgrammaticName + is the exact name of a method within its interface. + + @returns + the user-visible name of the specified function. */ - string getDisplayFunctionName( [in] string aProgrammaticName ); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAddIn::getFunctionDescription - - // DocMerge from xml: method com::sun::star::sheet::XAddIn::getFunctionDescription - /** returns the description of the function. - - - + string getDisplayFunctionName( [in] string aProgrammaticName ); + + //------------------------------------------------------------------------- + + /** returns the description of a function. + <p>The description is shown to the user when selecting functions. It may be translated to the current language of the AddIn.</p> + + @param aProgrammaticName + is the exact name of a method within its interface. + + @returns + the description of the specified function. */ - string getFunctionDescription( [in] string aProgrammaticName ); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAddIn::getDisplayArgumentName - - // DocMerge from xml: method com::sun::star::sheet::XAddIn::getDisplayArgumentName + string getFunctionDescription( [in] string aProgrammaticName ); + + //------------------------------------------------------------------------- + /** returns the user-visible name of the specified argument. - - - + <p>The argument name is shown to the user when prompting for arguments. It should be a single word and may be translated to the current language of the AddIn.</p> + + @param aProgrammaticFunctionName + is the exact name of a method within its interface. + + @param nArgument + the index of the argument (0-based). + + @returns + the user-visible name of the specified argument. */ - string getDisplayArgumentName( [in] string aProgrammaticFunctionName, - [in] long nArgument ); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAddIn::getArgumentDescription - - // DocMerge from xml: method com::sun::star::sheet::XAddIn::getArgumentDescription + string getDisplayArgumentName( + [in] string aProgrammaticFunctionName, + [in] long nArgument ); + + //------------------------------------------------------------------------- + /** returns the description of the specified argument. - - - + <p>The argument description is shown to the user when prompting for arguments. It may be translated to the current language of the AddIn.</p> + + @param aProgrammaticFunctionName + is the exact name of a method within its interface. + + @param nArgument + the index of the argument (0-based). + + @returns + the description of the specified argument. */ - string getArgumentDescription( [in] string aProgrammaticFunctionName, - [in] long nArgument ); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAddIn::getProgrammaticCategoryName - - // DocMerge from xml: method com::sun::star::sheet::XAddIn::getProgrammaticCategoryName - /** returns the programmatic name of the category the function belongs to. - - - + string getArgumentDescription( + [in] string aProgrammaticFunctionName, + [in] long nArgument ); + + //------------------------------------------------------------------------- + + /** returns the programmatic name of the category the function + belongs to. + <p>The category name is used to group similar functions together. The programmatic category name should always be in English, it is never shown to the user. It should be one of the following names if the function falls into the corresponding category.</p> + <dl> - <dt>Database - </dt> - <dd>for functions that operate with data organized in tabular - form like databases. - </dd> - <dt>Date&amp;Time - </dt> - <dd>for functions that deal with date or time values. - </dd> - <dt>Financial - </dt> - <dd>for functions that solve financial problems. - </dd> - <dt>Information - </dt> - <dd>for functions that provide information about cells. - </dd> - <dt>Logical - </dt> - <dd>for functions that deal with logical expressions. - </dd> - <dt>Mathematical - </dt> - <dd>for mathematical functions. - </dd> - <dt>Matrix - </dt> - <dd>for matrix functions. - </dd> - <dt>Statistical - </dt> - <dd>for statistical functions. - </dd> - <dt>Spreadsheet - </dt> - <dd>for functions that deal with cell ranges. - </dd> - <dt>Text - </dt> - <dd>for functions that deal with text strings. - </dd> - <dt>Add-In - </dt> - <dd>for additional functions. - </dd> + <dt>Database</dt> + <dd>for functions that operate with data organized in tabular form + like databases.</dd> + + <dt>Date&Time</dt> + <dd>for functions that deal with date or time values.</dd> + + <dt>Financial</dt> + <dd>for functions that solve financial problems.</dd> + + <dt>Information</dt> + <dd>for functions that provide information about cells.</dd> + + <dt>Logical</dt> + <dd>for functions that deal with logical expressions.</dd> + + <dt>Mathematical</dt> + <dd>for mathematical functions.</dd> + + <dt>Matrix</dt> + <dd>for matrix functions.</dd> + + <dt>Statistical</dt> + <dd>for statistical functions.</dd> + + <dt>Spreadsheet</dt> + <dd>for functions that deal with cell ranges.</dd> + + <dt>Text</dt> + <dd>for functions that deal with text strings.</dd> + + <dt>Add-In</dt> + <dd>for additional functions.</dd> </dl> + + @param aProgrammaticFunctionName + is the exact name of a method within its interface. + + @returns + the category name the specified function belongs to. */ - string getProgrammaticCategoryName( [in] string aProgrammaticFunctionName ); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAddIn::getDisplayCategoryName - - // DocMerge from xml: method com::sun::star::sheet::XAddIn::getDisplayCategoryName - /** returns the user-visible name of the category the function belongs to. - - - + string getProgrammaticCategoryName( [in] string aProgrammaticFunctionName ); + + //------------------------------------------------------------------------- + + /** returns the user-visible name of the category the function + belongs to. + <p>This is used when category names are shown to the user.</p> + + @param aProgrammaticFunctionName + is the exact name of a method within its interface. + + @returns + the user-visible category name the specified function + belongs to. */ - string getDisplayCategoryName( [in] string aProgrammaticFunctionName ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.6 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.4 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.3 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.2 1999/12/14 11:30:35 nn - #70786# derive from XLocalizable - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + string getDisplayCategoryName( [in] string aProgrammaticFunctionName ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XAreaLink.idl b/offapi/com/sun/star/sheet/XAreaLink.idl index 90e873b35..e990e4a28 100644 --- a/offapi/com/sun/star/sheet/XAreaLink.idl +++ b/offapi/com/sun/star/sheet/XAreaLink.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAreaLink.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:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,104 +58,66 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XAreaLink_idl__ -#define __com_sun_star_sheet_XAreaLink_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.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::XAreaLink -/** represents a linked cell range.@see com::sun::star::sheet::CellAreaLink + +#ifndef __com_sun_star_sheet_XAreaLink_idl__ +#define __com_sun_star_sheet_XAreaLink_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.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 change the settings of a linked cell range. + + @see com::sun::star::sheet::CellAreaLink */ interface XAreaLink: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAreaLink::getSourceArea - - // DocMerge from xml: method com::sun::star::sheet::XAreaLink::getSourceArea - /** returns the source of the range within the - source document. - - - - <p>This can be the address of a cell or range in the form - "sheet1.a1:c5", or the name of a named range or database range.</p> +{ + //------------------------------------------------------------------------- + + /** returns the source of the range within the source document. + + <p>This can be the address of a cell or range in the form + "Sheet1.A1:C5", or the name of a named range or database range.</p> */ - string getSourceArea(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XAreaLink::setSourceArea + string getSourceArea(); + + //------------------------------------------------------------------------- + /** sets the source of the range within the source document. - - - - <p>This can be the address of a cell or range in the form - "sheet1.a1:c5", or the name of a named range or database range.</p> + + <p>This can be the address of a cell or range in the form + "Sheet1.A1:C5", or the name of a named range or database range.</p> */ - void setSourceArea( [in] string aSourceArea ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XAreaLink::getDestArea - /** returns the position of the linked range - in the destination document. + void setSourceArea( [in] string aSourceArea ); + + //------------------------------------------------------------------------- + + /** returns the position of the linked range in the destination + document. */ - com::sun::star::table::CellRangeAddress getDestArea(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XAreaLink::setDestArea - /** sets the position of the linked range - in the destination document. + com::sun::star::table::CellRangeAddress getDestArea(); + + //------------------------------------------------------------------------- + + /** sets the position of the linked range in the destination document. */ - void setDestArea( [in] com::sun::star::table::CellRangeAddress aDestArea ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:49 hjs - initial import - - Revision 1.5 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void setDestArea( [in] com::sun::star::table::CellRangeAddress aDestArea ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XAreaLinks.idl b/offapi/com/sun/star/sheet/XAreaLinks.idl index 7127561a5..1d7818986 100644 --- a/offapi/com/sun/star/sheet/XAreaLinks.idl +++ b/offapi/com/sun/star/sheet/XAreaLinks.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAreaLinks.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:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,74 +58,72 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XAreaLinks_idl__ -#define __com_sun_star_sheet_XAreaLinks_idl__ - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XAreaLinks -/** represents a collection of area links.@see com::sun::star::sheet::CellAreaLinks + +#ifndef __com_sun_star_sheet_XAreaLinks_idl__ +#define __com_sun_star_sheet_XAreaLinks_idl__ + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access via index to a collection of area links and inserting + and removing area links. + + @see com::sun::star::sheet::CellAreaLinks + @see com::sun::star::sheet::CellAreaLink */ interface XAreaLinks: com::sun::star::container::XIndexAccess -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XAreaLinks::insertAtPosition +{ + //------------------------------------------------------------------------- + /** creates an area link and adds it to the collection. + + @param aDestPos + the address of the first cell of the range inside the current + document. + + @param aFileName + the URL of the source document. + + @param aSourceArea + the name of the range in the source document. + + <p>This can be the address of a cell or range in the form + "Sheet1.A1:C5", or the name of a named range or database range.</p> + + @param aFilter + the name of the filter used to load the source document. + + @param aFilterOptions + optional filter options for the specified filter. */ - void insertAtPosition( [in] com::sun::star::table::CellAddress aDestPos, - [in] string aFileName, - [in] string aSourceArea, - [in] string aFilter, - [in] string aFilterOptions ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XAreaLinks::removeByIndex + void insertAtPosition( [in] com::sun::star::table::CellAddress aDestPos, + [in] string aFileName, + [in] string aSourceArea, + [in] string aFilter, + [in] string aFilterOptions ); + + //------------------------------------------------------------------------- + /** removes an area link from the collection. */ - void removeByIndex( [in] long nIndex ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void removeByIndex( [in] long nIndex ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XArrayFormulaRange.idl b/offapi/com/sun/star/sheet/XArrayFormulaRange.idl index 5b09e04da..b4b62cf17 100644 --- a/offapi/com/sun/star/sheet/XArrayFormulaRange.idl +++ b/offapi/com/sun/star/sheet/XArrayFormulaRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: XArrayFormulaRange.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,77 +58,46 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XArrayFormulaRange_idl__ -#define __com_sun_star_sheet_XArrayFormulaRange_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XArrayFormulaRange -/** represents something (such as a cell range) that - can contain an array formula. + +#ifndef __com_sun_star_sheet_XArrayFormulaRange_idl__ +#define __com_sun_star_sheet_XArrayFormulaRange_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides handling of array formulas in a cell range. */ interface XArrayFormulaRange: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XArrayFormulaRange::getArrayFormula - - // DocMerge from xml: method com::sun::star::sheet::XArrayFormulaRange::getArrayFormula - /** returns the array formula of the range. - - - - <p>If the range does not contain an array formula, - an empty string is returned.</p> +{ + //------------------------------------------------------------------------- + + /** returns the array formula of the range or an empty string, if the + range does not contain an array formula. */ - string getArrayFormula(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XArrayFormulaRange::setArrayFormula - /** sets the array formula of the range. - - - - <p>Setting this to an empty string erases the array formula.</p> + string getArrayFormula(); + + //------------------------------------------------------------------------- + + /** applies the array formula to the entire cell range. + + @param aFormula + the formula that will be applied as array formula. Passing an + empty string erases an existing array formula. */ - void setArrayFormula( [in] string aFormula ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.5 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void setArrayFormula( [in] string aFormula ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XCalculatable.idl b/offapi/com/sun/star/sheet/XCalculatable.idl index 9fa9d8d56..d0b0754cf 100644 --- a/offapi/com/sun/star/sheet/XCalculatable.idl +++ b/offapi/com/sun/star/sheet/XCalculatable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCalculatable.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:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,96 +58,72 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XCalculatable_idl__ -#define __com_sun_star_sheet_XCalculatable_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XCalculatable + +#ifndef __com_sun_star_sheet_XCalculatable_idl__ +#define __com_sun_star_sheet_XCalculatable_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** represents something that can recalculate. */ interface XCalculatable: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCalculatable::calculate +{ + //------------------------------------------------------------------------- + /** recalculates all dirty cells. - - - - <p>This calculates all formula cells which have not yet been + + <p>This calculates all formula cells which have not yet been calculated after their precedents have changed.</p> */ - void calculate(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCalculatable::calculateAll + void calculate(); + + //------------------------------------------------------------------------- + /** recalculates all cells. */ - void calculateAll(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCalculatable::isAutomaticCalculationEnabled - /** returns <TRUE/> if automatic calculation is enabled. - - - - <p>With automatic calculation, each formula cell is - recalculated whenever its value is needed after its - precedents have changed. The value is needed if the - cell is displayed or used in another calculation.</p> + void calculateAll(); + + //------------------------------------------------------------------------- + + /** returns whether automatic calculation is enabled. + + <p>With automatic calculation, each formula cell is recalculated + whenever its value is needed after its precedents have changed. + The value is needed if the cell is displayed or used in another + calculation.</p> + + @returns + <TRUE/>, if automatic calculation is enabled. */ - boolean isAutomaticCalculationEnabled(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCalculatable::enableAutomaticCalculation + boolean isAutomaticCalculationEnabled(); + + //------------------------------------------------------------------------- + /** enables automatic calculation. - - - - <p>With automatic calculation, each formula cell is - recalculated whenever its value is needed after its - precedents have changed. The value is needed if the - cell is displayed or used in another calculation.</p> + + <p>With automatic calculation, each formula cell is recalculated + whenever its value is needed after its precedents have changed. + The value is needed if the cell is displayed or used in another + calculation.</p> + + @param bEnabled + <TRUE/> to enable automatic calculation, <FALSE/> to disable. */ - [oneway] void enableAutomaticCalculation( [in] boolean bEnabled ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:40 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [oneway] void enableAutomaticCalculation( [in] boolean bEnabled ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XCellAddressable.idl b/offapi/com/sun/star/sheet/XCellAddressable.idl index 530510c47..f0aa6594e 100644 --- a/offapi/com/sun/star/sheet/XCellAddressable.idl +++ b/offapi/com/sun/star/sheet/XCellAddressable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellAddressable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,61 +58,43 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XCellAddressable_idl__ -#define __com_sun_star_sheet_XCellAddressable_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XCellAddressable -/** represents a cell which can be addressed with - a <type scope="com::sun::star::table">CellAddress</type>. + +#ifndef __com_sun_star_sheet_XCellAddressable_idl__ +#define __com_sun_star_sheet_XCellAddressable_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a cell which can be addressed with a + <type scope="com::sun::star::table">CellAddress</type>. */ interface XCellAddressable: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellAddressable::getCellAddress - /** returns the position of the cell in the document. +{ + //------------------------------------------------------------------------- + + /** returns the address of the cell in the spreadsheet document. + + <p>The <type scope="com::sun::star::table">CellAddress</type> + can be used to address the cell within its document.</p> */ - com::sun::star::table::CellAddress getCellAddress(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.4 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::table::CellAddress getCellAddress(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XCellFormatRangesSupplier.idl b/offapi/com/sun/star/sheet/XCellFormatRangesSupplier.idl index 3b17972f6..33947ff29 100644 --- a/offapi/com/sun/star/sheet/XCellFormatRangesSupplier.idl +++ b/offapi/com/sun/star/sheet/XCellFormatRangesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellFormatRangesSupplier.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:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,63 +58,52 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XCellFormatRangesSupplier_idl__ -#define __com_sun_star_sheet_XCellFormatRangesSupplier_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XCellFormatRangesSupplier -/** provides a collection of cell formats. + +#ifndef __com_sun_star_sheet_XCellFormatRangesSupplier_idl__ +#define __com_sun_star_sheet_XCellFormatRangesSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to a collection of equal-formatted cell ranges. + + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SheetCellRanges */ interface XCellFormatRangesSupplier: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellFormatRangesSupplier::getCellFormatRanges - /** returns the collection of cell formats.@see com::sun::star::sheet::CellFormatRanges +{ + //------------------------------------------------------------------------- + + /** returns a collection of equal-formatted cell ranges. + + <p>Each cell of the original range is contained in one of the + ranges (even unformatted cells). If there is a non-rectangular + equal-formatted cell area, it will be split into several + rectangular ranges.</p> + + @returns + the collection of equal-formatted cell ranges. + + @see com::sun::star::sheet::CellFormatRanges */ - com::sun::star::container::XIndexAccess getCellFormatRanges(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::container::XIndexAccess getCellFormatRanges(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XCellRangeAddressable.idl b/offapi/com/sun/star/sheet/XCellRangeAddressable.idl index 6beab42f4..6c9599961 100644 --- a/offapi/com/sun/star/sheet/XCellRangeAddressable.idl +++ b/offapi/com/sun/star/sheet/XCellRangeAddressable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellRangeAddressable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,63 +58,43 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XCellRangeAddressable_idl__ -#define __com_sun_star_sheet_XCellRangeAddressable_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.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::XCellRangeAddressable -/** represents a cell range which can be addressed with - a CellRangeAddress. + +#ifndef __com_sun_star_sheet_XCellRangeAddressable_idl__ +#define __com_sun_star_sheet_XCellRangeAddressable_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.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 { + +//============================================================================= + +/** represents a cell which can be addressed with a + <type scope="com::sun::star::table">CellRangeAddress</type>. */ interface XCellRangeAddressable: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellRangeAddressable::getRangeAddress - /** returns the address of the range. - - - +{ + //------------------------------------------------------------------------- + + /** returns the address of the cell range in the spreadsheet document. + <p>The <type scope="com::sun::star::table">CellRangeAddress</type> can be used to address the range within its document.</p> */ - com::sun::star::table::CellRangeAddress getRangeAddress(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::table::CellRangeAddress getRangeAddress(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XCellRangeData.idl b/offapi/com/sun/star/sheet/XCellRangeData.idl index ffd2c1669..e989c5993 100644 --- a/offapi/com/sun/star/sheet/XCellRangeData.idl +++ b/offapi/com/sun/star/sheet/XCellRangeData.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellRangeData.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: tl $ $Date: 2002-04-29 10:09:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,17 +65,14 @@ #include <com/sun/star/uno/XInterface.idl> #endif - //============================================================================= - - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= /** allows to get and set an array of data from a cell range. - * - * <p>The outer sequence represents the rows and the inner sequence - * the columns of the array.</p> + <p>The outer sequence represents the rows and the inner sequence + the columns of the array.</p> */ interface XCellRangeData: com::sun::star::uno::XInterface @@ -89,22 +86,18 @@ interface XCellRangeData: com::sun::star::uno::XInterface /** fills the cell range with values from an array. - <p>The size of the array must be the same as the size of - the cell range. - Each element of the array must contain a <atom>double</atom> + <p>The size of the array must be the same as the size of the cell + range. Each element of the array must contain a <atom>double</atom> or a <atom>string</atom>.</p> - <p>If the size of the array is different from the current - size a <type scope="com::sun::star::uno">RuntimeException</type> - is thrown.</p> + @throws <type scope="com::sun::star::uno">RuntimeException</type> + If the size of the array is different from the current size. */ void setDataArray( [in] sequence< sequence< any > > aArray ); }; //============================================================================= - }; }; }; }; - #endif diff --git a/offapi/com/sun/star/sheet/XCellRangeMovement.idl b/offapi/com/sun/star/sheet/XCellRangeMovement.idl index 96dc64e90..aca8860b7 100644 --- a/offapi/com/sun/star/sheet/XCellRangeMovement.idl +++ b/offapi/com/sun/star/sheet/XCellRangeMovement.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellRangeMovement.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,98 +58,108 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XCellRangeMovement_idl__ -#define __com_sun_star_sheet_XCellRangeMovement_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_table_CellRangeAddress_idl__ -#include <com/sun/star/table/CellRangeAddress.idl> -#endif - -#ifndef __com_sun_star_sheet_CellInsertMode_idl__ -#include <com/sun/star/sheet/CellInsertMode.idl> -#endif - -#ifndef __com_sun_star_sheet_CellDeleteMode_idl__ -#include <com/sun/star/sheet/CellDeleteMode.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XCellRangeMovement -/** has functions for moving ranges of cells in a sheet. + +#ifndef __com_sun_star_sheet_XCellRangeMovement_idl__ +#define __com_sun_star_sheet_XCellRangeMovement_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_table_CellRangeAddress_idl__ +#include <com/sun/star/table/CellRangeAddress.idl> +#endif + +#ifndef __com_sun_star_sheet_CellInsertMode_idl__ +#include <com/sun/star/sheet/CellInsertMode.idl> +#endif + +#ifndef __com_sun_star_sheet_CellDeleteMode_idl__ +#include <com/sun/star/sheet/CellDeleteMode.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods for moving ranges of cells in a sheet. */ interface XCellRangeMovement: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellRangeMovement::insertCells +{ + //------------------------------------------------------------------------- + /** inserts cells, moving other cells down or right. - - - + <p>Non-empty cells cannot be moved off the sheet.</p> + + @param aRange + the cell range in which empty cells will be inserted. + + @param nMode + describes how to move existing cells. */ - void insertCells( [in] com::sun::star::table::CellRangeAddress aRange, - [in] com::sun::star::sheet::CellInsertMode nMode ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellRangeMovement::removeRange + void insertCells( + [in] com::sun::star::table::CellRangeAddress aRange, + [in] com::sun::star::sheet::CellInsertMode nMode ); + + //------------------------------------------------------------------------- + /** deletes cells, moving other cells up or left. + + @param aRange + the cell range to remove. + + @param nMode + describes how to move following cells. */ - void removeRange( [in] com::sun::star::table::CellRangeAddress aRange, - [in] com::sun::star::sheet::CellDeleteMode nMode ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellRangeMovement::moveRange + void removeRange( + [in] com::sun::star::table::CellRangeAddress aRange, + [in] com::sun::star::sheet::CellDeleteMode nMode ); + + //------------------------------------------------------------------------- + /** moves a cell range to another position in the document. + + <p>After copying the contents of the cell range, all cells + will be cleared.</p> + + @param aDestination + the address of the top left cell of the destination range. + + @param aSource + the cell range which will be copied. */ - void moveRange( [in] com::sun::star::table::CellAddress aDestination, - [in] com::sun::star::table::CellRangeAddress aSource ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellRangeMovement::copyRange + void moveRange( + [in] com::sun::star::table::CellAddress aDestination, + [in] com::sun::star::table::CellRangeAddress aSource ); + + //------------------------------------------------------------------------- + /** copies a cell range to another position in the document. + + <p>The source cell range keeps unchanged.</p> + + @param aDestination + the address of the top left cell of the destination range. + + @param aSource + the cell range which will be copied. */ - void copyRange( [in] com::sun::star::table::CellAddress aDestination, - [in] com::sun::star::table::CellRangeAddress aSource ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void copyRange( + [in] com::sun::star::table::CellAddress aDestination, + [in] com::sun::star::table::CellRangeAddress aSource ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XCellRangeReferrer.idl b/offapi/com/sun/star/sheet/XCellRangeReferrer.idl index 356a63d04..36bc20de7 100644 --- a/offapi/com/sun/star/sheet/XCellRangeReferrer.idl +++ b/offapi/com/sun/star/sheet/XCellRangeReferrer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellRangeReferrer.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:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,67 +58,45 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XCellRangeReferrer_idl__ -#define __com_sun_star_sheet_XCellRangeReferrer_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_table_XCellRange_idl__ -#include <com/sun/star/table/XCellRange.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XCellRangeReferrer -/** allows direct access to the cells in a named range or - to the cells which are visible in a view, without the need to get the - document object first.@see com::sun::star::sheet::NamedRange - @see com::sun::star::sheet::DatabaseRange - @see com::sun::star::sheet::SpreadsheetViewPane + +#ifndef __com_sun_star_sheet_XCellRangeReferrer_idl__ +#define __com_sun_star_sheet_XCellRangeReferrer_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_table_XCellRange_idl__ +#include <com/sun/star/table/XCellRange.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** allows direct access to the cells in a named range or to the cells + which are visible in a view, without the need to get the document + object first. + + @see com::sun::star::sheet::NamedRange + @see com::sun::star::sheet::DatabaseRange + @see com::sun::star::sheet::SpreadsheetViewPane */ interface XCellRangeReferrer: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellRangeReferrer::getReferredCells - /** returns the cell range that is represented. +{ + //------------------------------------------------------------------------- + + /** returns the cell range object that is represented. */ - com::sun::star::table::XCellRange getReferredCells(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::table::XCellRange getReferredCells(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XCellRangesQuery.idl b/offapi/com/sun/star/sheet/XCellRangesQuery.idl index 1b5af7b76..2e010f3ba 100644 --- a/offapi/com/sun/star/sheet/XCellRangesQuery.idl +++ b/offapi/com/sun/star/sheet/XCellRangesQuery.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellRangesQuery.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:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,158 +58,149 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XCellRangesQuery_idl__ -#define __com_sun_star_sheet_XCellRangesQuery_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_XSheetCellRanges_idl__ -#include <com/sun/star/sheet/XSheetCellRanges.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.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::XCellRangesQuery -/** provides methods to invoke queries on cells.@see com::sun::star::sheet::SheetRangesQuery + +#ifndef __com_sun_star_sheet_XCellRangesQuery_idl__ +#define __com_sun_star_sheet_XCellRangesQuery_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetCellRanges_idl__ +#include <com/sun/star/sheet/XSheetCellRanges.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.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 query for cell ranges with specific contents. + + <p>All methods return a collection of cell ranges.</p> + + @see com::sun::star::sheet::SheetRangesQuery + @see com::sun::star::sheet::SheetCellRanges */ interface XCellRangesQuery: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryVisibleCells - /** points the cursor to only the visible (not hidden) - cells of those to which it currently points. +{ + //------------------------------------------------------------------------- + + /** queries all visible cells. + + @returns + the visible (not hidden) cells of the current cell range(s). */ - com::sun::star::sheet::XSheetCellRanges queryVisibleCells(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryEmptyCells - /** collapses the cursor to the empty cells within the range to which it is currently pointing. - - - - <p>After this operation the cursor only contains the empty cells - out of those which it pointed before.</p> + com::sun::star::sheet::XSheetCellRanges queryVisibleCells(); + + //------------------------------------------------------------------------- + + /** queries all empty cells. + + @returns + the empty cells of the current cell range(s). */ - com::sun::star::sheet::XSheetCellRanges queryEmptyCells(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryContentCells - /** collapses the cursor to the cells with the specified content type - within the range to which it is currently pointing. - - - - <p>After this operation, the cursor only contains cells with the specified - content type out of those which it pointed before. - - </p> + com::sun::star::sheet::XSheetCellRanges queryEmptyCells(); + + //------------------------------------------------------------------------- + + /** queries all cells with the specified content type(s). + + @param nContentFlags + a combination of <type>CellFlags</type> flags. + + <p>Attention: Despite the <type>CellFlags</type> flags are + <atom>long</atom> values, this method expects a <atom>short</atom> + parameter. + + @returns + all cells of the current cell range(s) with the specified + content type(s). */ - com::sun::star::sheet::XSheetCellRanges queryContentCells( [in] short nContentFlags ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryFormulaCells - /** queries all cells with a specified result type. - - - - <p>The set of cells to which the cursor is currently pointing - will be collapsed into a subset. This subset is specified by the - formula cells containing results of a specified type</p>. + com::sun::star::sheet::XSheetCellRanges queryContentCells( + [in] short nContentFlags ); + + //------------------------------------------------------------------------- + + /** queries all formula cells with the specified result type. + + @param nResultFlags + a combination of <type>FormulaResult</type> flags. + + @returns + all formula cells of the current cell range(s) with the + specified result type(s). */ - com::sun::star::sheet::XSheetCellRanges queryFormulaCells( [in] long nResultFlags ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryColumnDifferences - /** queries all cells which have a different value in - a specified row. - - - - <p>The set of cells to which the cursor is currently pointing - will be collapsed into a subset. This subset is specified by all - cells which have a different value in the same column of the - specified row.</p> + com::sun::star::sheet::XSheetCellRanges queryFormulaCells( + [in] long nResultFlags ); + + //------------------------------------------------------------------------- + + /** queries all cells with different values in a specified row. + + <p>This method takes each column of the current cell range(s) and + compares all cells with the cell in the specified row. All cells + which are different to this comparison cell will be returned.</p> + + @param aCompare + contains a cell address with the row index used for comparison. + Only this row index is of interest. + + @returns + all cells of the current cell range(s) which are different + to the comparison cell of each column. */ - com::sun::star::sheet::XSheetCellRanges queryColumnDifferences( [in] com::sun::star::table::CellAddress aCompare ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryRowDifferences - /** queries all cells which have a different value in - a specified column. - - - - <p>The set of cells to which the cursor is currently pointing - will be collapsed into a subset. This subset is specified by all - cells which have a different value in the same row of the - specified column.</p> + com::sun::star::sheet::XSheetCellRanges queryColumnDifferences( + [in] com::sun::star::table::CellAddress aCompare ); + + //------------------------------------------------------------------------- + + /** queries all cells with different values in a specified column. + + <p>This method takes each row of the current cell range(s) and + compares all cells with the cell in the specified column. All cells + which are different to this comparison cell will be returned.</p> + + @param aCompare + contains a cell address with the column index used for + comparison. Only this column index is of interest. + + @returns + all cells of the current cell range(s) which are different + to the comparison cell of each row. */ - com::sun::star::sheet::XSheetCellRanges queryRowDifferences( [in] com::sun::star::table::CellAddress aCompare ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryIntersection - /** intersects the cursor with the specified cell range. - - - - <p>The set of cells to which the cursor is currently pointing - will be collapsed into a subset. This subset is specified by all - cells which are also in the specified range.</p> + com::sun::star::sheet::XSheetCellRanges queryRowDifferences( + [in] com::sun::star::table::CellAddress aCompare ); + + //------------------------------------------------------------------------- + + /** intersects the current cell range(s) with the specified cell range. + + @param aRange + contains the cell range for intersection. + + @return + all cells of the current cell range(s) which are contained + in the passed cell range. + */ - com::sun::star::sheet::XSheetCellRanges queryIntersection( [in] com::sun::star::table::CellRangeAddress aRange ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:49 hjs - initial import - - Revision 1.4 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.2 1999/11/25 16:03:33 mi - welforming HTML for XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::sheet::XSheetCellRanges queryIntersection( + [in] com::sun::star::table::CellRangeAddress aRange ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XCellSeries.idl b/offapi/com/sun/star/sheet/XCellSeries.idl index e3fb03b29..1aa90930f 100644 --- a/offapi/com/sun/star/sheet/XCellSeries.idl +++ b/offapi/com/sun/star/sheet/XCellSeries.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellSeries.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,79 +58,87 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XCellSeries_idl__ -#define __com_sun_star_sheet_XCellSeries_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_FillDirection_idl__ -#include <com/sun/star/sheet/FillDirection.idl> -#endif - -#ifndef __com_sun_star_sheet_FillMode_idl__ -#include <com/sun/star/sheet/FillMode.idl> -#endif - -#ifndef __com_sun_star_sheet_FillDateMode_idl__ -#include <com/sun/star/sheet/FillDateMode.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XCellSeries -/** represents a cell range that can be filled with a - series. + +#ifndef __com_sun_star_sheet_XCellSeries_idl__ +#define __com_sun_star_sheet_XCellSeries_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_FillDirection_idl__ +#include <com/sun/star/sheet/FillDirection.idl> +#endif + +#ifndef __com_sun_star_sheet_FillMode_idl__ +#include <com/sun/star/sheet/FillMode.idl> +#endif + +#ifndef __com_sun_star_sheet_FillDateMode_idl__ +#include <com/sun/star/sheet/FillDateMode.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to fill out a cell range automatically with values + based on a start value, step count and fill mode. + + @see com::sun::star::sheet::SheetCellRange */ interface XCellSeries: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellSeries::fillSeries - /** fills the cells in the range. +{ + //------------------------------------------------------------------------- + + /** fills all cells in the range based on the specified settings. + + @param nFillDirection + specifies the direction to fill the rows/columns of the range. + + @param nFillMode + specifies the type of the series. + + @param nFillDateMode + specifies the calculation mode for date values. + + @param fStep + contains the value used to increase/decrease the series values. + + @param fEndValue + contains the threshold value on which the calculation of the + current series stops. */ - void fillSeries( [in] com::sun::star::sheet::FillDirection nFillDirection, - [in] com::sun::star::sheet::FillMode nFillMode, - [in] com::sun::star::sheet::FillDateMode nFillDateMode, - [in] double fStep, - [in] double fEndValue ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XCellSeries::fillAuto - /** fills the cells in the range in a way that is specified by - the first cells in the range. + void fillSeries( + [in] com::sun::star::sheet::FillDirection nFillDirection, + [in] com::sun::star::sheet::FillMode nFillMode, + [in] com::sun::star::sheet::FillDateMode nFillDateMode, + [in] double fStep, + [in] double fEndValue ); + + //------------------------------------------------------------------------- + + /** fills all cells in the range in a way that is specified by the + first cell(s) in the range. + + @param nFillDirection + specifies the direction to fill the rows/columns of the range. + + @param nSourceCount + contains the number of cells in each row/column used to + constitute the fill algorithm. */ - void fillAuto( [in] com::sun::star::sheet::FillDirection nFillDirection, - [in] long nSourceCount ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void fillAuto( + [in] com::sun::star::sheet::FillDirection nFillDirection, + [in] long nSourceCount ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XCompatibilityNames.idl b/offapi/com/sun/star/sheet/XCompatibilityNames.idl index 067ac959f..c0811b902 100644 --- a/offapi/com/sun/star/sheet/XCompatibilityNames.idl +++ b/offapi/com/sun/star/sheet/XCompatibilityNames.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCompatibilityNames.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,45 +58,59 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XCompatibilityNames_idl__ -#define __com_sun_star_sheet_XCompatibilityNames_idl__ - -#ifndef __com_sun_star_sheet_LocalizedName_idl__ -#include <com/sun/star/sheet/LocalizedName.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= -/** gives access to an AddIn's compatibility names. +#ifndef __com_sun_star_sheet_XCompatibilityNames_idl__ +#define __com_sun_star_sheet_XCompatibilityNames_idl__ + +#ifndef __com_sun_star_sheet_LocalizedName_idl__ +#include <com/sun/star/sheet/LocalizedName.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** gives access to the sequence of compatibility names for an Addin + function. */ interface XCompatibilityNames: com::sun::star::uno::XInterface { - /** returns the compatibility names of the function. + /** returns the compatibility names of the specified function. - <p>The compatibility names are used for import and export to other - applications. They may be locale-dependent. - The default name for each locale must be the first for that locale. - The first entry in the sequence must be for the default - locale (used for a locale that is not in the list). - If a function doesn't have any compatibility names, - the returned sequence is empty.</p> + <p>Compatibility names are localized names of AddIn functions that + are used to import files from other applications.</p> -<!-- JRH: Needs rewriting to clarify. --> -<!-- Editor: The sentence "The default name for each locale must be the first - for that locale" is confusing --> -<!-- Editor: Maybe an example would help. --> + <p>If on import a localized function name is read, this list of + compatibility names is used to find the internal name of the + function. The current locale may differ from the locale used in + the imported file, so the method + <member>XAddIn::getProgrammaticFuntionName</member> cannot be used + here.</p> + + <p>The order inside the sequence of compatibility names is used to + prioritize the names. Initially the first compatibility name of + each function is compared to the imported name (each function may + provide a sequence of compatibility names - the first entry of all + sequences is used). If no entry is equal, the second entry of each + sequence is used and so on.</p> + + <p>If a locale is not present in the sequence of compatibility names, + the first entry of the sequence is used. So the method should return + a sequence which contains first the entry representing the current + locale.<TRUE/></p> + + @param aProgrammaticName + is the exact name of a method within its interface. */ - sequence<LocalizedName> getCompatibilityNames( [in] string aProgrammaticName ); -}; - -//============================================================================= - -}; }; }; }; - + sequence< com::sun::star::sheet::LocalizedName > + getCompatibilityNames( [in] string aProgrammaticName ); +}; + +//============================================================================= + +}; }; }; }; + #endif diff --git a/offapi/com/sun/star/sheet/XConsolidatable.idl b/offapi/com/sun/star/sheet/XConsolidatable.idl index 739264ba2..cc2053049 100644 --- a/offapi/com/sun/star/sheet/XConsolidatable.idl +++ b/offapi/com/sun/star/sheet/XConsolidatable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConsolidatable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,79 +58,64 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XConsolidatable_idl__ -#define __com_sun_star_sheet_XConsolidatable_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_XConsolidationDescriptor_idl__ -#include <com/sun/star/sheet/XConsolidationDescriptor.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XConsolidatable -/** represents a spreadsheet document that can - consolidate ranges. - - - - - - - - - - - - - + +#ifndef __com_sun_star_sheet_XConsolidatable_idl__ +#define __com_sun_star_sheet_XConsolidatable_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_XConsolidationDescriptor_idl__ +#include <com/sun/star/sheet/XConsolidationDescriptor.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to consolidate ranges in a spreadsheet document. + + <p>Consolidation combines the cells of multiple cell ranges, using a + specific function.</p> + @deprecated */ interface XConsolidatable: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XConsolidatable::createConsolidationDescriptor +{ + //------------------------------------------------------------------------- + /** creates a consolidation descriptor. + + @param bEmpty + <TRUE/> leaves the descriptor empty, <FALSE/> fills it with + the settings from the last consolidation action. + + @see com::sun::star::sheet::ConsolidationDescriptor */ - com::sun::star::sheet::XConsolidationDescriptor createConsolidationDescriptor( [in] boolean bEmpty ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XConsolidatable::consolidate - /** consolidates data from several cell ranges. + com::sun::star::sheet::XConsolidationDescriptor createConsolidationDescriptor( + [in] boolean bEmpty ); + + //------------------------------------------------------------------------- + + /** consolidates data from several cell ranges, using the settings + in the passed descriptor. + + @param xDescriptor + the descriptor used to perform the consolidation. + + @see com::sun::star::sheet::ConsolidationDescriptor */ - void consolidate( [in] com::sun::star::sheet::XConsolidationDescriptor xDescriptor ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void consolidate( + [in] com::sun::star::sheet::XConsolidationDescriptor xDescriptor ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XConsolidationDescriptor.idl b/offapi/com/sun/star/sheet/XConsolidationDescriptor.idl index 315b8c2b3..6d7706977 100644 --- a/offapi/com/sun/star/sheet/XConsolidationDescriptor.idl +++ b/offapi/com/sun/star/sheet/XConsolidationDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConsolidationDescriptor.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:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,172 +58,127 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XConsolidationDescriptor_idl__ -#define __com_sun_star_sheet_XConsolidationDescriptor_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_GeneralFunction_idl__ -#include <com/sun/star/sheet/GeneralFunction.idl> -#endif - -#ifndef __com_sun_star_table_CellRangeAddress_idl__ -#include <com/sun/star/table/CellRangeAddress.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XConsolidationDescriptor -/** represents a description of how to consolidate multiple - cell ranges. - - - - - - - - @deprecated@see com::sun::star::sheet::ConsolidationDescriptor + +#ifndef __com_sun_star_sheet_XConsolidationDescriptor_idl__ +#define __com_sun_star_sheet_XConsolidationDescriptor_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_GeneralFunction_idl__ +#include <com/sun/star/sheet/GeneralFunction.idl> +#endif + +#ifndef __com_sun_star_table_CellRangeAddress_idl__ +#include <com/sun/star/table/CellRangeAddress.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to the settings of a consolidation descriptor. + + @deprecated + + @see com::sun::star::sheet::ConsolidationDescriptor */ interface XConsolidationDescriptor: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::getFunction +{ + //------------------------------------------------------------------------- + /** returns the function by which the ranges are consolidated. */ - com::sun::star::sheet::GeneralFunction getFunction(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::setFunction + com::sun::star::sheet::GeneralFunction getFunction(); + + //------------------------------------------------------------------------- + /** sets the function by which the ranges are consolidated. */ - void setFunction( [in] com::sun::star::sheet::GeneralFunction nFunction ); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XConsolidationDescriptor::getSources - - // DocMerge from idl: method com::sun::star::sheet::XConsolidationDescriptor::getSources + void setFunction( [in] com::sun::star::sheet::GeneralFunction nFunction ); + + //------------------------------------------------------------------------- + /** returns the cell ranges which are consolidated. */ - sequence<com::sun::star::table::CellRangeAddress> getSources(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::setSources + sequence< com::sun::star::table::CellRangeAddress > getSources(); + + //------------------------------------------------------------------------- + /** sets the cell ranges which are consolidated. */ - void setSources( [in] sequence<com::sun::star::table::CellRangeAddress> aSources ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::getStartOutputPosition - /** returns the position in the document where the - consolidated data are copied. + void setSources( + [in] sequence< com::sun::star::table::CellRangeAddress > aSources ); + + //------------------------------------------------------------------------- + + /** returns the position of the top left cell of the cell range where + the consolidated data are copied. */ - com::sun::star::table::CellAddress getStartOutputPosition(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::setStartOutputPosition - /** sets the position in the document where the - consolidated data are copied. + com::sun::star::table::CellAddress getStartOutputPosition(); + + //------------------------------------------------------------------------- + + /** sets the position of the top left cell of the cell range + where the consolidated data are copied. */ - void setStartOutputPosition( [in] com::sun::star::table::CellAddress aStartOutputPosition ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::getUseColumnHeaders - /** returns whether column headers from the cell ranges - are used to find matching data or not. + void setStartOutputPosition( + [in] com::sun::star::table::CellAddress aStartOutputPosition ); + + //------------------------------------------------------------------------- + + /** returns, whether column headers from the cell ranges are used to + find matching data or not. */ - boolean getUseColumnHeaders(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::setUseColumnHeaders - /** specifies if column headers from the cell ranges - are used to find matching data. + boolean getUseColumnHeaders(); + + //------------------------------------------------------------------------- + + /** specifies if column headers from the cell ranges are used to find + matching data. */ - void setUseColumnHeaders( [in] boolean bUseColumnHeaders ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::getUseRowHeaders - /** returns whether row headers from the cell ranges - are used to find matching data or not. + void setUseColumnHeaders( [in] boolean bUseColumnHeaders ); + + //------------------------------------------------------------------------- + + /** returns, whether row headers from the cell ranges are used to + find matching data or not. */ - boolean getUseRowHeaders(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::setUseRowHeaders - /** specifies if row headers from the cell ranges - are used to find matching data. + boolean getUseRowHeaders(); + + //------------------------------------------------------------------------- + + /** specifies if row headers from the cell ranges are used to find + matching data. */ - void setUseRowHeaders( [in] boolean bUseRowHeaders ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::getInsertLinks - /** returns whether links to the original data - are inserted in the output area or not. + void setUseRowHeaders( [in] boolean bUseRowHeaders ); + + //------------------------------------------------------------------------- + + /** returns, whether links to the original data are inserted in the + output area or not. */ - boolean getInsertLinks(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::setInsertLinks - /** specifies if links to the original data - are inserted in the output area. + boolean getInsertLinks(); + + //------------------------------------------------------------------------- + + /** specifies if links to the original data are inserted in the + output area. */ - void setInsertLinks( [in] boolean bInsertLinks ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:49 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void setInsertLinks( [in] boolean bInsertLinks ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XDDELink.idl b/offapi/com/sun/star/sheet/XDDELink.idl index f594244b7..e043693e0 100644 --- a/offapi/com/sun/star/sheet/XDDELink.idl +++ b/offapi/com/sun/star/sheet/XDDELink.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDDELink.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:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,91 +58,52 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XDDELink_idl__ -#define __com_sun_star_sheet_XDDELink_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XDDELink -/** represents a DDE link. - - - - - - - - @deprecated@see com::sun::star::sheet::DDELink + +#ifndef __com_sun_star_sheet_XDDELink_idl__ +#define __com_sun_star_sheet_XDDELink_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to change the settings of a DDE link. + + @deprecated + + @see com::sun::star::sheet::DDELink */ interface XDDELink: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDDELink::getApplication - - // DocMerge from xml: method com::sun::star::sheet::XDDELink::getApplication +{ + //------------------------------------------------------------------------- + /** returns the application from which data are requested (the DDE server application). */ - string getApplication(); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDDELink::getTopic - - // DocMerge from xml: method com::sun::star::sheet::XDDELink::getTopic + string getApplication(); + + //------------------------------------------------------------------------- + /** returns the DDE topic from which data are requested. */ - string getTopic(); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDDELink::getItem - - // DocMerge from xml: method com::sun::star::sheet::XDDELink::getItem + string getTopic(); + + //------------------------------------------------------------------------- + /** returns the DDE item from which data are requested. */ - string getItem(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + string getItem(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XDataPilotDescriptor.idl b/offapi/com/sun/star/sheet/XDataPilotDescriptor.idl index 058f23e88..c4941471d 100644 --- a/offapi/com/sun/star/sheet/XDataPilotDescriptor.idl +++ b/offapi/com/sun/star/sheet/XDataPilotDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataPilotDescriptor.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:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,161 +58,127 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__ -#define __com_sun_star_sheet_XDataPilotDescriptor_idl__ - -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - -#ifndef __com_sun_star_table_CellRangeAddress_idl__ -#include <com/sun/star/table/CellRangeAddress.idl> -#endif - -#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__ -#include <com/sun/star/sheet/XSheetFilterDescriptor.idl> -#endif - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XDataPilotDescriptor -/** represents a description of a data pilot table.@see com::sun::star::sheet::DataPilotDescriptor - @see com::sun::star::sheet::DataPilotTable + +#ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__ +#define __com_sun_star_sheet_XDataPilotDescriptor_idl__ + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +#ifndef __com_sun_star_table_CellRangeAddress_idl__ +#include <com/sun/star/table/CellRangeAddress.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__ +#include <com/sun/star/sheet/XSheetFilterDescriptor.idl> +#endif + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to the layout settings of a data pilot table. + + <p>This interface extends the interface + <type scope="com::sun::star::container">XNamed</type> which provides + access to the name of the data pilot table used i.e. in collections.</p> + + @see com::sun::star::sheet::DataPilotDescriptor + @see com::sun::star::sheet::DataPilotTable */ interface XDataPilotDescriptor: com::sun::star::container::XNamed -{ - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDataPilotDescriptor::getTag - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getTag - /** returns an additional string stored in the - data pilot table. +{ + //------------------------------------------------------------------------- + + /** returns an additional string stored in the data pilot table. */ - string getTag(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::setTag - /** sets an additional string stored in the - data pilot table. + string getTag(); + + //------------------------------------------------------------------------- + + /** sets an additional string stored in the data pilot table. */ - void setTag( [in] string aTag ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getSourceRange - /** returns the cell range containing the data - for the data pilot table. + void setTag( [in] string aTag ); + + //------------------------------------------------------------------------- + + /** returns the cell range containing the data for the data pilot table. */ - com::sun::star::table::CellRangeAddress getSourceRange(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::setSourceRange - /** sets the cell range containing the - data for the data pilot table. + com::sun::star::table::CellRangeAddress getSourceRange(); + + //------------------------------------------------------------------------- + + /** sets the cell range containing the data for the data pilot table. */ - void setSourceRange( [in] com::sun::star::table::CellRangeAddress aSourceRange ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getFilterDescriptor - /** returns the filter descriptor specifying - which data from the source cell range are used for the - data pilot table. + void setSourceRange( + [in] com::sun::star::table::CellRangeAddress aSourceRange ); + + //------------------------------------------------------------------------- + + /** returns the filter descriptor specifying which data from the + source cell range are used for the data pilot table. */ - com::sun::star::sheet::XSheetFilterDescriptor getFilterDescriptor(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getDataPilotFields - /** returns the collection of all the data - pilot fields. + com::sun::star::sheet::XSheetFilterDescriptor getFilterDescriptor(); + + //------------------------------------------------------------------------- + + /** returns the collection of all the data pilot fields. */ - com::sun::star::container::XIndexAccess getDataPilotFields(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getColumnFields - /** returns the collection of the data pilot - fields used as column fields. + com::sun::star::container::XIndexAccess getDataPilotFields(); + + //------------------------------------------------------------------------- + + /** returns the collection of the data pilot fields used as column fields. + + @see com::sun::star::sheet::DataPilotFields */ - com::sun::star::container::XIndexAccess getColumnFields(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getRowFields - /** returns the collection of the data pilot - fields used as row fields. + com::sun::star::container::XIndexAccess getColumnFields(); + + //------------------------------------------------------------------------- + + /** returns the collection of the data pilot fields used as row fields. + + @see com::sun::star::sheet::DataPilotFields */ - com::sun::star::container::XIndexAccess getRowFields(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getPageFields - /** returns the collection of the data pilot - fields used as page fields. + com::sun::star::container::XIndexAccess getRowFields(); + + //------------------------------------------------------------------------- + + /** returns the collection of the data pilot fields used as page fields. + + @see com::sun::star::sheet::DataPilotFields */ - com::sun::star::container::XIndexAccess getPageFields(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getDataFields - /** returns the collection of the data pilot - fields used as data fields. + com::sun::star::container::XIndexAccess getPageFields(); + + //------------------------------------------------------------------------- + + /** returns the collection of the data pilot fields used as data fields. + + @see com::sun::star::sheet::DataPilotFields */ - com::sun::star::container::XIndexAccess getDataFields(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getHiddenFields - /** returns the collection of the data pilot - fields not used as column, row, page, or data fields. + com::sun::star::container::XIndexAccess getDataFields(); + + //------------------------------------------------------------------------- + + /** returns the collection of the data pilot fields not used as + column, row, page, or data fields. + + @see com::sun::star::sheet::DataPilotFields */ - com::sun::star::container::XIndexAccess getHiddenFields(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::container::XIndexAccess getHiddenFields(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XDataPilotMemberResults.idl b/offapi/com/sun/star/sheet/XDataPilotMemberResults.idl index 0764a9a42..66f221b11 100644 --- a/offapi/com/sun/star/sheet/XDataPilotMemberResults.idl +++ b/offapi/com/sun/star/sheet/XDataPilotMemberResults.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataPilotMemberResults.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,64 +58,47 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XDataPilotMemberResults_idl__ -#define __com_sun_star_sheet_XDataPilotMemberResults_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_MemberResult_idl__ -#include <com/sun/star/sheet/MemberResult.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XDataPilotMemberResults -/** gives access to member results. + +#ifndef __com_sun_star_sheet_XDataPilotMemberResults_idl__ +#define __com_sun_star_sheet_XDataPilotMemberResults_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_MemberResult_idl__ +#include <com/sun/star/sheet/MemberResult.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to a sequence of results of a data pilot source level. + + <p>These results are used to fill the data area for the level in a data + pilot table.</p> + + @see com::sun::star::sheet::DataPilotSourceLevel + @see com::sun::star::sheet::DataPilotSource + @see com::sun::star::sheet::XDataPilotResults */ interface XDataPilotMemberResults: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDataPilotMemberResults::getResults - - // DocMerge from idl: method com::sun::star::sheet::XDataPilotMemberResults::getResults - /** returns the member results. +{ + //------------------------------------------------------------------------- + + /** returns the sequence of results for the regarding data pilot + source level. */ - sequence<com::sun::star::sheet::MemberResult> getResults(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + sequence< com::sun::star::sheet::MemberResult > getResults(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XDataPilotResults.idl b/offapi/com/sun/star/sheet/XDataPilotResults.idl index 1c92ec36e..3867c735d 100644 --- a/offapi/com/sun/star/sheet/XDataPilotResults.idl +++ b/offapi/com/sun/star/sheet/XDataPilotResults.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataPilotResults.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,63 +58,47 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XDataPilotResults_idl__ -#define __com_sun_star_sheet_XDataPilotResults_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_DataResult_idl__ -#include <com/sun/star/sheet/DataResult.idl> -#endif - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XDataPilotResults -/** gives access to results. + +#ifndef __com_sun_star_sheet_XDataPilotResults_idl__ +#define __com_sun_star_sheet_XDataPilotResults_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_DataResult_idl__ +#include <com/sun/star/sheet/DataResult.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to a table of results of a data pilot source. + + <p>These results are used to fill the data area of a data pilot table.</p> + + @see com::sun::star::sheet::DataPilotSource + @see com::sun::star::sheet::XDataPilotMemberResults */ interface XDataPilotResults: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDataPilotResults::getResults - - // DocMerge from idl: method com::sun::star::sheet::XDataPilotResults::getResults +{ + //------------------------------------------------------------------------- + /** returns the result array. + + <p>The outer sequence contains the value rows. The inner sequences + contain the values for one row.</p> */ - sequence< sequence<DataResult> > getResults(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + sequence< sequence< DataResult > > getResults(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XDataPilotTable.idl b/offapi/com/sun/star/sheet/XDataPilotTable.idl index 72b359ba9..83afcf606 100644 --- a/offapi/com/sun/star/sheet/XDataPilotTable.idl +++ b/offapi/com/sun/star/sheet/XDataPilotTable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataPilotTable.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:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,73 +58,50 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XDataPilotTable_idl__ -#define __com_sun_star_sheet_XDataPilotTable_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.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::XDataPilotTable -/** represents a data pilot table which has already - been created.@see com::sun::star::sheet::DataPilotTable + +#ifndef __com_sun_star_sheet_XDataPilotTable_idl__ +#define __com_sun_star_sheet_XDataPilotTable_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.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 control a data pilot table which has already + been created. + + @see com::sun::star::sheet::DataPilotTable */ interface XDataPilotTable: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotTable::getOutputRange - /** returns the address of the cell range that - contains the data pilot table. +{ + //------------------------------------------------------------------------- + + /** returns the address of the cell range that contains the data + pilot table. */ - com::sun::star::table::CellRangeAddress getOutputRange(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotTable::refresh - /** recreates the data pilot table with current - data from the source cell range. + com::sun::star::table::CellRangeAddress getOutputRange(); + + //------------------------------------------------------------------------- + + /** recreates the data pilot table with current data from the source + cell range. */ - void refresh(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void refresh(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XDataPilotTables.idl b/offapi/com/sun/star/sheet/XDataPilotTables.idl index 65c1b22e1..1a4987702 100644 --- a/offapi/com/sun/star/sheet/XDataPilotTables.idl +++ b/offapi/com/sun/star/sheet/XDataPilotTables.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataPilotTables.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:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,84 +58,83 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XDataPilotTables_idl__ -#define __com_sun_star_sheet_XDataPilotTables_idl__ - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - -#ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__ -#include <com/sun/star/sheet/XDataPilotDescriptor.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XDataPilotTables -/** represents a collection of data pilot tables.@see com::sun::star::sheet::DataPilotTables + +#ifndef __com_sun_star_sheet_XDataPilotTables_idl__ +#define __com_sun_star_sheet_XDataPilotTables_idl__ + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif + +#ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__ +#include <com/sun/star/sheet/XDataPilotDescriptor.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to the data pilot tables via name and inserting and + removing data pilot tables. + + <p>This interface extends the interface + <type scope="com::sun::star::container">XNameAccess</type> which provides + access to existing data pilot tables in the collection.</p> + + @see com::sun::star::sheet::DataPilotTables + @see com::sun::star::sheet::DataPilotTable */ interface XDataPilotTables: com::sun::star::container::XNameAccess -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotTables::createDataPilotDescriptor - /** creates a data pilot descriptor which can - be used with addTable(). +{ + //------------------------------------------------------------------------- + + /** creates a data pilot descriptor. + + <p>This descriptor can be used with + <member>XDataPilotTables::addTable</member>.</p> + + @see com::sun::star::sheet::DataPilotTableDescriptor */ - com::sun::star::sheet::XDataPilotDescriptor createDataPilotDescriptor(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotTables::insertNewByName + com::sun::star::sheet::XDataPilotDescriptor createDataPilotDescriptor(); + + //------------------------------------------------------------------------- + /** creates a new data pilot table and adds it to the collection. + + @param aName + the name of the data pilot table used in the collection. + + @param aAoutputAddress + the top left cell of the location of the data pilot table in + the spreadsheet document. + + @param xDescriptor + the descriptor containing the settings of the data pilot table. + + @see com::sun::star::sheet::DataPilotTableDescriptor */ - void insertNewByName( [in] string aName, - [in] com::sun::star::table::CellAddress aOutputAddress, - [in] com::sun::star::sheet::XDataPilotDescriptor xDescriptor ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotTables::removeByName - /** deletes a data pilot table. + void insertNewByName( + [in] string aName, + [in] com::sun::star::table::CellAddress aOutputAddress, + [in] com::sun::star::sheet::XDataPilotDescriptor xDescriptor ); + + //------------------------------------------------------------------------- + + /** deletes a data pilot table from the collection. */ - void removeByName( [in] string aName ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void removeByName( [in] string aName ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XDataPilotTablesSupplier.idl b/offapi/com/sun/star/sheet/XDataPilotTablesSupplier.idl index 7bc323b93..0869bfb00 100644 --- a/offapi/com/sun/star/sheet/XDataPilotTablesSupplier.idl +++ b/offapi/com/sun/star/sheet/XDataPilotTablesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataPilotTablesSupplier.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:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,63 +58,43 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XDataPilotTablesSupplier_idl__ -#define __com_sun_star_sheet_XDataPilotTablesSupplier_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_XDataPilotTables_idl__ -#include <com/sun/star/sheet/XDataPilotTables.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XDataPilotTablesSupplier -/** grants access to a collection of data pilot tables.@see com::sun::star::sheet::Spreadsheet + +#ifndef __com_sun_star_sheet_XDataPilotTablesSupplier_idl__ +#define __com_sun_star_sheet_XDataPilotTablesSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_XDataPilotTables_idl__ +#include <com/sun/star/sheet/XDataPilotTables.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** grants access to a collection of data pilot tables. + + @see com::sun::star::sheet::Spreadsheet */ interface XDataPilotTablesSupplier: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDataPilotTablesSupplier::getDataPilotTables - /** returns the collection of data pilot tables.@see DataPilotTables +{ + //------------------------------------------------------------------------- + + /** Returns the collection of data pilot tables. + + @see com::sun::star::sheet::DataPilotTables */ - com::sun::star::sheet::XDataPilotTables getDataPilotTables(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::sheet::XDataPilotTables getDataPilotTables(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XDatabaseRange.idl b/offapi/com/sun/star/sheet/XDatabaseRange.idl index cd75b7a54..e9680027c 100644 --- a/offapi/com/sun/star/sheet/XDatabaseRange.idl +++ b/offapi/com/sun/star/sheet/XDatabaseRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDatabaseRange.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:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,143 +58,104 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XDatabaseRange_idl__ -#define __com_sun_star_sheet_XDatabaseRange_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_table_CellRangeAddress_idl__ -#include <com/sun/star/table/CellRangeAddress.idl> -#endif - -#ifndef __com_sun_star_beans_PropertyValue_idl__ -#include <com/sun/star/beans/PropertyValue.idl> -#endif - -#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__ -#include <com/sun/star/sheet/XSheetFilterDescriptor.idl> -#endif - -#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__ -#include <com/sun/star/sheet/XSubTotalDescriptor.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XDatabaseRange -/** represents a cell range for which data operations are defined.@see com::sun::star::sheet::DatabaseRange + +#ifndef __com_sun_star_sheet_XDatabaseRange_idl__ +#define __com_sun_star_sheet_XDatabaseRange_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_table_CellRangeAddress_idl__ +#include <com/sun/star/table/CellRangeAddress.idl> +#endif + +#ifndef __com_sun_star_beans_PropertyValue_idl__ +#include <com/sun/star/beans/PropertyValue.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__ +#include <com/sun/star/sheet/XSheetFilterDescriptor.idl> +#endif + +#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__ +#include <com/sun/star/sheet/XSubTotalDescriptor.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to the settings and options of a database range. + + @see com::sun::star::sheet::DatabaseRange */ interface XDatabaseRange: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDatabaseRange::getDataArea - /** returns the data area of the database range. +{ + //------------------------------------------------------------------------- + + /** returns the data area of the database range in the + spreadsheet document. */ - com::sun::star::table::CellRangeAddress getDataArea(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDatabaseRange::setDataArea + com::sun::star::table::CellRangeAddress getDataArea(); + + //------------------------------------------------------------------------- + /** sets the data area of the database range. */ - void setDataArea( [in] com::sun::star::table::CellRangeAddress aDataArea ); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDatabaseRange::getSortDescriptor - - // DocMerge from idl: method com::sun::star::sheet::XDatabaseRange::getSortDescriptor - /** returns the sort descriptor stored with the - database range. + void setDataArea( [in] com::sun::star::table::CellRangeAddress aDataArea ); + + //------------------------------------------------------------------------- + + /** returns the sort descriptor stored with the database range. + + @see com::sun::star::sheet::SheetSortDescriptor */ - sequence<com::sun::star::beans::PropertyValue> getSortDescriptor(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDatabaseRange::getFilterDescriptor - /** returns the filter descriptor stored with the - database range. - - - - <p>If the filter descriptor is modified, the new filtering - is carried out when <member>XDatabaseRange::refresh()</member> - is called.</p> + sequence< com::sun::star::beans::PropertyValue > getSortDescriptor(); + + //------------------------------------------------------------------------- + + /** returns the filter descriptor stored with the database range. + + <p>If the filter descriptor is modified, the new filtering is + carried out when <member>XDatabaseRange::refresh()</member> is + called.</p> */ - com::sun::star::sheet::XSheetFilterDescriptor getFilterDescriptor(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDatabaseRange::getSubTotalDescriptor + com::sun::star::sheet::XSheetFilterDescriptor getFilterDescriptor(); + + //------------------------------------------------------------------------- + /** returns the subtotal descriptor stored with the database range. - - - <p>If the subtotal descriptor is modified, the new subtotals - are inserted when <member>XDatabaseRange::refresh()</member> - is called.</p> + + <p>If the subtotal descriptor is modified, the new subtotals are + inserted when <member>XDatabaseRange::refresh()</member> is + called.</p> */ - com::sun::star::sheet::XSubTotalDescriptor getSubTotalDescriptor(); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDatabaseRange::getImportDescriptor - - // DocMerge from idl: method com::sun::star::sheet::XDatabaseRange::getImportDescriptor - /** returns the <type>DatabaseImportDescriptor</type> stored with this - database range. + com::sun::star::sheet::XSubTotalDescriptor getSubTotalDescriptor(); + + //------------------------------------------------------------------------- + + /** returns the database import descriptor stored with this database + range. + + @see com::sun::star::sheet::DatabaseImportDescriptor */ - sequence<com::sun::star::beans::PropertyValue> getImportDescriptor(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDatabaseRange::refresh - /** executes the stored import, filter, sorting, - and subtotals descriptors again. + sequence< com::sun::star::beans::PropertyValue > getImportDescriptor(); + + //------------------------------------------------------------------------- + + /** executes the stored import, filter, sorting, and subtotals + descriptors again. */ - void refresh(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 mi - moved from api - - Revision 1.3 2000/10/10 09:03:09 mi - returned service specified - - 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:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void refresh(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XDatabaseRanges.idl b/offapi/com/sun/star/sheet/XDatabaseRanges.idl index cdd2885a6..f39bb861c 100644 --- a/offapi/com/sun/star/sheet/XDatabaseRanges.idl +++ b/offapi/com/sun/star/sheet/XDatabaseRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDatabaseRanges.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:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,72 +58,49 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XDatabaseRanges_idl__ -#define __com_sun_star_sheet_XDatabaseRanges_idl__ - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.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::XDatabaseRanges -/** provides functions to manage a collection of - database ranges.@see com::sun::star::sheet::DatabaseRanges + +#ifndef __com_sun_star_sheet_XDatabaseRanges_idl__ +#define __com_sun_star_sheet_XDatabaseRanges_idl__ + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.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 functions to manage a collection of database ranges. + + @see com::sun::star::sheet::DatabaseRanges */ interface XDatabaseRanges: com::sun::star::container::XNameAccess -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDatabaseRanges::addNewByName +{ + //------------------------------------------------------------------------- + /** adds a new database range to the collection. */ - void addNewByName( [in] string aName, - [in] com::sun::star::table::CellRangeAddress aRange ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDatabaseRanges::removeByName + void addNewByName( + [in] string aName, + [in] com::sun::star::table::CellRangeAddress aRange ); + + //------------------------------------------------------------------------- + /** removes a database range from the collection. */ - void removeByName( [in] string aName ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void removeByName( [in] string aName ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XDimensionsSupplier.idl b/offapi/com/sun/star/sheet/XDimensionsSupplier.idl index 5acc6f94e..623879291 100644 --- a/offapi/com/sun/star/sheet/XDimensionsSupplier.idl +++ b/offapi/com/sun/star/sheet/XDimensionsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDimensionsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,57 +58,43 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XDimensionsSupplier_idl__ -#define __com_sun_star_sheet_XDimensionsSupplier_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XDimensionsSupplier -/** gives access to dimensions. + +#ifndef __com_sun_star_sheet_XDimensionsSupplier_idl__ +#define __com_sun_star_sheet_XDimensionsSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to the collection of dimensions of a data pilot source. + + @see com::sun::star::sheet::DataPilotSource */ interface XDimensionsSupplier: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDimensionsSupplier::getDimensions - /** returns the dimensions. +{ + //------------------------------------------------------------------------- + + /** returns the collection of dimensions. + + @see com::sun::star::sheet::DataPilotSourceDimensions */ - com::sun::star::container::XNameAccess getDimensions(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::container::XNameAccess getDimensions(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XDocumentAuditing.idl b/offapi/com/sun/star/sheet/XDocumentAuditing.idl index d0b63174d..84bb19843 100644 --- a/offapi/com/sun/star/sheet/XDocumentAuditing.idl +++ b/offapi/com/sun/star/sheet/XDocumentAuditing.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDocumentAuditing.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,59 +58,39 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XDocumentAuditing_idl__ -#define __com_sun_star_sheet_XDocumentAuditing_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XDocumentAuditing -/** represents auditing functions of a document. + +#ifndef __com_sun_star_sheet_XDocumentAuditing_idl__ +#define __com_sun_star_sheet_XDocumentAuditing_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides auditing functions of a document. */ interface XDocumentAuditing: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XDocumentAuditing::refreshArrows - /** refreshes all existing auditing arrows on - all sheets of the document. - - - - <p>Dependencies are marked for all the cells that were - marked before, but using current formulas.</p> +{ + //------------------------------------------------------------------------- + + /** refreshes all existing auditing arrows on all sheets of the + document. + + <p>Dependencies are marked for all the cells that were marked + before, but using current formulas.</p> */ - void refreshArrows(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void refreshArrows(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XFillAcrossSheet.idl b/offapi/com/sun/star/sheet/XFillAcrossSheet.idl index fca05a137..d96f6a363 100644 --- a/offapi/com/sun/star/sheet/XFillAcrossSheet.idl +++ b/offapi/com/sun/star/sheet/XFillAcrossSheet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFillAcrossSheet.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,60 +58,37 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XFillAcrossSheet_idl__ -#define __com_sun_star_sheet_XFillAcrossSheet_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XFillAcrossSheet -/** uno! - - - - - - @deprecated + +#ifndef __com_sun_star_sheet_XFillAcrossSheet_idl__ +#define __com_sun_star_sheet_XFillAcrossSheet_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module sheet { + +//============================================================================= + +/** @deprecated */ interface XFillAcrossSheet: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XFillAcrossSheet::fillAcrossSheets - /** copies data between ranges onto different sheets in +{ + //------------------------------------------------------------------------- + + /** copies data between ranges onto different sheets in the document. */ - void fillAcrossSheets( [in] long nContentFlags ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void fillAcrossSheets( [in] long nContentFlags ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XFormulaQuery.idl b/offapi/com/sun/star/sheet/XFormulaQuery.idl index 4439cf1dd..59ebd4eb2 100644 --- a/offapi/com/sun/star/sheet/XFormulaQuery.idl +++ b/offapi/com/sun/star/sheet/XFormulaQuery.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFormulaQuery.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:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,83 +58,77 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XFormulaQuery_idl__ -#define __com_sun_star_sheet_XFormulaQuery_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_XSheetCellRanges_idl__ -#include <com/sun/star/sheet/XSheetCellRanges.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XFormulaQuery -/** provides methods to query cells for dependencies - in formulas.@see com::sun::star::sheet::SheetRangesQuery + +#ifndef __com_sun_star_sheet_XFormulaQuery_idl__ +#define __com_sun_star_sheet_XFormulaQuery_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetCellRanges_idl__ +#include <com/sun/star/sheet/XSheetCellRanges.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to query cells for dependencies + in formulas. + + <p>All methods return a collection of cell ranges.</p> + + @see com::sun::star::sheet::SheetRangesQuery + @see com::sun::star::sheet::SheetCellRanges */ interface XFormulaQuery: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XFormulaQuery::queryDependents - /** points the cursor to the cells which are dependent on - the cells to which it is currently pointing. - - - - <p>Dependent cells are cells containing formulas with - references to the original cells.</p> +{ + //------------------------------------------------------------------------- + + /** queries all dependent formula cells. + + <p>Dependent cells are cells containing formulas with references to + the original cell.</p> + + @param bRecursive + <FALSE/> = queries cells dependent from the original range(s), + <TRUE/> = repeates query with all found cells + (finds dependents of dependents, and so on). + + @return + all dependent cells of any formula cell of the current + cell range(s). */ - com::sun::star::sheet::XSheetCellRanges queryDependents( [in] boolean bRecursive ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XFormulaQuery::queryPrecedents - /** points the cursor to the cells which are precedent - to the cells to which it is currently pointing. - - - - <p>Precedent cells are cells which are used in formulas as - references in the original cells.</p> + com::sun::star::sheet::XSheetCellRanges queryDependents( + [in] boolean bRecursive ); + + //------------------------------------------------------------------------- + + /** queries all precedent cells. + + <p>Precedent cells are cells which are referenced from a formula + cell.</p> + + @param bRecursive + <FALSE/> = queries precedent cells of the original range(s), + <TRUE/> = repeates query with all found cells + (finds precedents of precedents, and so on). + + @return + all precedent cells of any formula cell of the current cell + range(s). */ - com::sun::star::sheet::XSheetCellRanges queryPrecedents( [in] boolean bRecursive ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::sheet::XSheetCellRanges queryPrecedents( + [in] boolean bRecursive ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XFunctionAccess.idl b/offapi/com/sun/star/sheet/XFunctionAccess.idl index f1dc42427..408598d4f 100644 --- a/offapi/com/sun/star/sheet/XFunctionAccess.idl +++ b/offapi/com/sun/star/sheet/XFunctionAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFunctionAccess.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:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,91 +58,102 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XFunctionAccess_idl__ -#define __com_sun_star_sheet_XFunctionAccess_idl__ -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif +#ifndef __com_sun_star_sheet_XFunctionAccess_idl__ +#define __com_sun_star_sheet_XFunctionAccess_idl__ -#ifndef __com_sun_star_container_NoSuchElementException_idl__ -#include <com/sun/star/container/NoSuchElementException.idl> -#endif +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_container_NoSuchElementException_idl__ +#include <com/sun/star/container/NoSuchElementException.idl> +#endif -#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ -#include <com/sun/star/lang/IllegalArgumentException.idl> -#endif +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - /** allows generic access to all spreadsheet functions. + + @see com::sun::star::sheet::FunctionAccess */ interface XFunctionAccess: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- +{ + //------------------------------------------------------------------------- + /** calls a function and returns the result of the call. - @param aName + @param aName the (programmatic) name of the function. - @param aArguments + @param aArguments the arguments for the function call. <p>Each element must be of one of the following types:</p> + <dl> <dt><atom>long</atom> or <atom>double</atom></dt> <dd>for a numeric value.</dd> + <dt><atom>string</atom></dt> <dd>for a textual value.</dd> - <dt><atom">long[][]</atom> or - <atom">double[][]</atom></dt> + + <dt><atom>long[][]</atom> or <atom>double[][]</atom></dt> <dd>for an array of numeric values.</dd> + <dt><atom>string[][]</atom></dt> <dd>for an array of textual values.</dd> + <dt><atom>any[][]</atom></dt> <dd>for a mixed array, where each element must be of <void/>, - <atom>long</atom>, <atom>double</atom> or - <atom>string</atom> type.</dd> + <atom>long</atom>, <atom>double</atom> or <atom>string</atom> + type.</dd> + <dt><type scope="com::sun::star::table">XCellRange</type></dt> - <dd>for a <type>SheetCellRange</type> object - that contains the data. + <dd>for a <type>SheetCellRange</type> object that contains the + data.</dd> </dl> @returns - the result of the function call. - <p>Possible types for the result are:</p> - <dl> - <dt><void/></dt> - <dd>if no result is available.</dd> - <dt><atom>double</atom></dt> - <dd>for a numeric result.</dd> - <dt><atom>string</atom></dt> - <dd>for a textual result.</dd> - <dt><atom>any[][]</atom></dt> - <dd>for an array result, containing <atom>double</atom> and + the result of the function call. + + <p>Possible types for the result are:</p> + + <dl> + <dt><void/></dt> + <dd>if no result is available.</dd> + + <dt><atom>double</atom></dt> + <dd>for a numeric result.</dd> + + <dt><atom>string</atom></dt> + <dd>for a textual result.</dd> + + <dt><atom>any[][]</atom></dt> + <dd>for an array result, containing <atom>double</atom> and <atom>string</atom> values.</dd> - </dl> + </dl> - @throws NoSuchElementException - if the named function does not exist. + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if the named function does not exist. - @throws IllegalArgumentException - if the function can not be called with these arguments. + @throws <type scope="com::sun::star::lang">IllegalArgumentException</type> + if the function can not be called with these arguments. */ - any callFunction( [in] string aName, [in] sequence<any> aArguments ) - raises( com::sun::star::container::NoSuchElementException, - com::sun::star::lang::IllegalArgumentException ); -}; - -//============================================================================= - -}; }; }; }; - + any callFunction( [in] string aName, [in] sequence< any > aArguments ) + raises( com::sun::star::container::NoSuchElementException, + com::sun::star::lang::IllegalArgumentException ); +}; -#endif +//============================================================================= + +}; }; }; }; +#endif diff --git a/offapi/com/sun/star/sheet/XFunctionDescriptions.idl b/offapi/com/sun/star/sheet/XFunctionDescriptions.idl index a8acb92cc..339ff1393 100644 --- a/offapi/com/sun/star/sheet/XFunctionDescriptions.idl +++ b/offapi/com/sun/star/sheet/XFunctionDescriptions.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFunctionDescriptions.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:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,82 +58,60 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XFunctionDescriptions_idl__ -#define __com_sun_star_sheet_XFunctionDescriptions_idl__ - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> -#endif - -#ifndef __com_sun_star_beans_PropertyValue_idl__ -#include <com/sun/star/beans/PropertyValue.idl> -#endif - -#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ -#include <com/sun/star/lang/IllegalArgumentException.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XFunctionDescriptions -/** manages the list of descriptions of functions.@see com::sun::star::sheet::FunctionDescriptions + +#ifndef __com_sun_star_sheet_XFunctionDescriptions_idl__ +#define __com_sun_star_sheet_XFunctionDescriptions_idl__ + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +#ifndef __com_sun_star_beans_PropertyValue_idl__ +#include <com/sun/star/beans/PropertyValue.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to the property sequence of a function description + via function index or identifier. + + <p>The container access methods return a sequence of + <type scope="com::sun::star::beans">PropertyValue</type> structs. + The properties contained in the sequence are collected in the service + <type>FunctionDescription</type>.</p> + + @see com::sun::star::sheet::FunctionDescriptions */ interface XFunctionDescriptions: com::sun::star::container::XIndexAccess -{ - //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::sheet::XFunctionDescriptions::getById - /** finds a function description by its identifier. - - @returns - the <type>FunctionDescription</type>. - - @param nId - This is the identifier of the function description. +{ + //------------------------------------------------------------------------- + + /** finds a function description by the identifier of the function. + + @param nId + is the identifier of the function description (the same that + is used in the service <type>RecentFunctions</type>.</p> + + @returns + the sequence of property values (described in + <type>FunctionDescription</type>). */ - sequence<com::sun::star::beans::PropertyValue> getById( [in] long nId ) - raises( com::sun::star::lang::IllegalArgumentException ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 mi - moved from api - - Revision 1.3 2000/10/10 09:03:09 mi - returned service specified - - 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:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + sequence< com::sun::star::beans::PropertyValue > getById( [in] long nId ) + raises( com::sun::star::lang::IllegalArgumentException ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XGoalSeek.idl b/offapi/com/sun/star/sheet/XGoalSeek.idl index a64991692..1067e2900 100644 --- a/offapi/com/sun/star/sheet/XGoalSeek.idl +++ b/offapi/com/sun/star/sheet/XGoalSeek.idl @@ -2,9 +2,9 @@ * * $RCSfile: XGoalSeek.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,64 +58,60 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XGoalSeek_idl__ -#define __com_sun_star_sheet_XGoalSeek_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_GoalResult_idl__ -#include <com/sun/star/sheet/GoalResult.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XGoalSeek -/** makes it possible to seek a goal for a cell. + +#ifndef __com_sun_star_sheet_XGoalSeek_idl__ +#define __com_sun_star_sheet_XGoalSeek_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_GoalResult_idl__ +#include <com/sun/star/sheet/GoalResult.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides seeking a goal value for a cell. */ interface XGoalSeek: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XGoalSeek::seekGoal - /** calculates a value which gives a specified result - in a formula. +{ + //------------------------------------------------------------------------- + + /** calculates a value which gives a specified result in a formula. + + @param aFormulaPosition + is the address of the formula cell used for the calculation. + + @param aVariablePosition + is the address of the cell that is used in the formula as + variable. + + @param aGoalValue + is the value which should be reached during the goal seek. + + @returns + the result of the goal seek, including the value that results + in the specified goal, using the specified formula. */ - com::sun::star::sheet::GoalResult seekGoal( [in] com::sun::star::table::CellAddress aFormulaPosition, - [in] com::sun::star::table::CellAddress aVariablePosition, - [in] string aGoalValue ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::sheet::GoalResult seekGoal( + [in] com::sun::star::table::CellAddress aFormulaPosition, + [in] com::sun::star::table::CellAddress aVariablePosition, + [in] string aGoalValue ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XHeaderFooterContent.idl b/offapi/com/sun/star/sheet/XHeaderFooterContent.idl index 2f523345a..628d3711f 100644 --- a/offapi/com/sun/star/sheet/XHeaderFooterContent.idl +++ b/offapi/com/sun/star/sheet/XHeaderFooterContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: XHeaderFooterContent.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:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,80 +58,63 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XHeaderFooterContent_idl__ -#define __com_sun_star_sheet_XHeaderFooterContent_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_text_XText_idl__ -#include <com/sun/star/text/XText.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XHeaderFooterContent -/** represents the contents of a header or footer on a page.@see com::sun::star::sheet::HeaderFooterContent + +#ifndef __com_sun_star_sheet_XHeaderFooterContent_idl__ +#define __com_sun_star_sheet_XHeaderFooterContent_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_text_XText_idl__ +#include <com/sun/star/text/XText.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to the text contents of a header or footer on a page. + + @see com::sun::star::sheet::HeaderFooterContent + @see com::sun::star::sheet::TablePageStyle */ interface XHeaderFooterContent: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::sheet::XHeaderFooterContent::getLeftText - /** @returns - the text which is printed in the left part of the header or footer. +{ + //------------------------------------------------------------------------- + + /** returns the text which is printed in the left part of the + header or footer. + + @see com::sun::star::text::Text */ - com::sun::star::text::XText getLeftText(); - - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::sheet::XHeaderFooterContent::getCenterText - /** @returns - the text which is printed in the center part of the header or footer. + com::sun::star::text::XText getLeftText(); + + //------------------------------------------------------------------------- + + /** returns the text which is printed in the center part of the + header or footer. + + @see com::sun::star::text::Text */ - com::sun::star::text::XText getCenterText(); - - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::sheet::XHeaderFooterContent::getRightText - /** @returns - the text which is printed in the right part of the header or footer. + com::sun::star::text::XText getCenterText(); + + //------------------------------------------------------------------------- + + /** returns the text which is printed in the right part of the + header or footer. + + @see com::sun::star::text::Text */ - com::sun::star::text::XText getRightText(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::text::XText getRightText(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XHierarchiesSupplier.idl b/offapi/com/sun/star/sheet/XHierarchiesSupplier.idl index 89b85deef..70da495bd 100644 --- a/offapi/com/sun/star/sheet/XHierarchiesSupplier.idl +++ b/offapi/com/sun/star/sheet/XHierarchiesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XHierarchiesSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,57 +58,45 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XHierarchiesSupplier_idl__ -#define __com_sun_star_sheet_XHierarchiesSupplier_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XHierarchiesSupplier -/** gives access to hierarchies. + +#ifndef __com_sun_star_sheet_XHierarchiesSupplier_idl__ +#define __com_sun_star_sheet_XHierarchiesSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to the collection of hierarchies of a data pilot source + dimension. + + @see com::sun::star::sheet::DataPilotSourceDimension + @see com::sun::star::sheet::DataPilotSource */ interface XHierarchiesSupplier: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XHierarchiesSupplier::getHierarchies - /** returns the hierarchies. +{ + //------------------------------------------------------------------------- + + /** returns the collection of hierarchies. + + @see com::sun::star::sheet::DataPilotSourceHierarchies */ - com::sun::star::container::XNameAccess getHierarchies(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::container::XNameAccess getHierarchies(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XLabelRange.idl b/offapi/com/sun/star/sheet/XLabelRange.idl index e0b7342ce..6bc8234b9 100644 --- a/offapi/com/sun/star/sheet/XLabelRange.idl +++ b/offapi/com/sun/star/sheet/XLabelRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLabelRange.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:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,91 +58,64 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XLabelRange_idl__ -#define __com_sun_star_sheet_XLabelRange_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.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::XLabelRange -/** represents a cell range that contains labels. - - - - <p>These can be column or row labels, depending on where they - are used.</p>@see com::sun::star::sheet::LabelRange + +#ifndef __com_sun_star_sheet_XLabelRange_idl__ +#define __com_sun_star_sheet_XLabelRange_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.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 access to the settings of a label range in a spreadsheet + document. + + <p>These can be column or row labels, depending on where they are used.</p> + + @see com::sun::star::sheet::LabelRange */ interface XLabelRange: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XLabelRange::getLabelArea - /** returns the address of the cell range that contains - the labels. +{ + //------------------------------------------------------------------------- + + /** returns the cell range address that contains the labels. */ - com::sun::star::table::CellRangeAddress getLabelArea(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XLabelRange::setLabelArea - /** sets the cell range that contains the labels. + com::sun::star::table::CellRangeAddress getLabelArea(); + + //------------------------------------------------------------------------- + + /** sets the cell range address that contains the labels. */ - void setLabelArea( [in] com::sun::star::table::CellRangeAddress aLabelArea ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XLabelRange::getDataArea - /** returns the address of the cell range for which - the labels are valid. + void setLabelArea( + [in] com::sun::star::table::CellRangeAddress aLabelArea ); + + //------------------------------------------------------------------------- + + /** returns the cell range address for which the labels are valid. */ - com::sun::star::table::CellRangeAddress getDataArea(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XLabelRange::setDataArea - /** sets the cell range for which the labels are valid. + com::sun::star::table::CellRangeAddress getDataArea(); + + //------------------------------------------------------------------------- + + /** sets the cell range address for which the labels are valid. */ - void setDataArea( [in] com::sun::star::table::CellRangeAddress aDataArea ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void setDataArea( + [in] com::sun::star::table::CellRangeAddress aDataArea ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XLabelRanges.idl b/offapi/com/sun/star/sheet/XLabelRanges.idl index a8de63bd7..dda10f9ff 100644 --- a/offapi/com/sun/star/sheet/XLabelRanges.idl +++ b/offapi/com/sun/star/sheet/XLabelRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLabelRanges.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:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,71 +58,57 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XLabelRanges_idl__ -#define __com_sun_star_sheet_XLabelRanges_idl__ - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.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::XLabelRanges -/** represents a collection of label ranges.@see com::sun::star::sheet::LabelRanges + +#ifndef __com_sun_star_sheet_XLabelRanges_idl__ +#define __com_sun_star_sheet_XLabelRanges_idl__ + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.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 the members of a label range collection + and to insert and remove them. + + @see com::sun::star::sheet::LabelRanges + @see com::sun::star::sheet::LabelRange */ interface XLabelRanges: com::sun::star::container::XIndexAccess -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XLabelRanges::addNew +{ + //------------------------------------------------------------------------- + /** adds a new label range to the collection. + + @param aLabelArea + the cell range containing the titles of the label range. + + @param aDataArea + the cell range containing the values of the label range. */ - void addNew( [in] com::sun::star::table::CellRangeAddress aLabelArea, - [in] com::sun::star::table::CellRangeAddress aDataArea ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XLabelRanges::removeByIndex + void addNew( + [in] com::sun::star::table::CellRangeAddress aLabelArea, + [in] com::sun::star::table::CellRangeAddress aDataArea ); + + //------------------------------------------------------------------------- + /** removes a label range from the collection. */ - void removeByIndex( [in] long nIndex ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void removeByIndex( [in] long nIndex ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XLevelsSupplier.idl b/offapi/com/sun/star/sheet/XLevelsSupplier.idl index 58f960240..fe62536da 100644 --- a/offapi/com/sun/star/sheet/XLevelsSupplier.idl +++ b/offapi/com/sun/star/sheet/XLevelsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLevelsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,57 +58,45 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XLevelsSupplier_idl__ -#define __com_sun_star_sheet_XLevelsSupplier_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XLevelsSupplier -/** gives access to levels. + +#ifndef __com_sun_star_sheet_XLevelsSupplier_idl__ +#define __com_sun_star_sheet_XLevelsSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to the collection of levels of a data pilot source + hierarchy. + + @see com::sun::star::sheet::DataPilotSourceHierarchy + @see com::sun::star::sheet::DataPilotSource */ interface XLevelsSupplier: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XLevelsSupplier::getLevels - /** returns the levels. +{ + //------------------------------------------------------------------------- + + /** returns the collection of levels. + + @see com::sun::star::sheet::DataPilotSourceLevels */ - com::sun::star::container::XNameAccess getLevels(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::container::XNameAccess getLevels(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XMembersSupplier.idl b/offapi/com/sun/star/sheet/XMembersSupplier.idl index c47ab60ee..97693112b 100644 --- a/offapi/com/sun/star/sheet/XMembersSupplier.idl +++ b/offapi/com/sun/star/sheet/XMembersSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMembersSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,57 +58,45 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XMembersSupplier_idl__ -#define __com_sun_star_sheet_XMembersSupplier_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XMembersSupplier -/** gives access to members. + +#ifndef __com_sun_star_sheet_XMembersSupplier_idl__ +#define __com_sun_star_sheet_XMembersSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to the collection of members of a data pilot source + level. + + @see com::sun::star::sheet::DataPilotSourceLevel + @see com::sun::star::sheet::DataPilotSource */ interface XMembersSupplier: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XMembersSupplier::getMembers - /** returns the members. +{ + //------------------------------------------------------------------------- + + /** returns the collection of members. + + @see com::sun::star::sheet::DataPilotSourceMembers */ - com::sun::star::container::XNameAccess getMembers(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::container::XNameAccess getMembers(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XMultipleOperation.idl b/offapi/com/sun/star/sheet/XMultipleOperation.idl index 1d75f19ec..286121aff 100644 --- a/offapi/com/sun/star/sheet/XMultipleOperation.idl +++ b/offapi/com/sun/star/sheet/XMultipleOperation.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMultipleOperation.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,74 +58,79 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XMultipleOperation_idl__ -#define __com_sun_star_sheet_XMultipleOperation_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_table_CellRangeAddress_idl__ -#include <com/sun/star/table/CellRangeAddress.idl> -#endif - -#ifndef __com_sun_star_sheet_TableOperationMode_idl__ -#include <com/sun/star/sheet/TableOperationMode.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XMultipleOperation -/** represents something in which a table of operations can be created. + +#ifndef __com_sun_star_sheet_XMultipleOperation_idl__ +#define __com_sun_star_sheet_XMultipleOperation_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_table_CellRangeAddress_idl__ +#include <com/sun/star/table/CellRangeAddress.idl> +#endif + +#ifndef __com_sun_star_sheet_TableOperationMode_idl__ +#include <com/sun/star/sheet/TableOperationMode.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides a method to apply a Multiple Operations Table to the + cell range. */ interface XMultipleOperation: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XMultipleOperation::setTableOperation - /** creates a table of formulas. - - - - <p>The specified formulas are repeated, with references - to the specified cells replaced by references to values - in the first column and/or row of the range.</p> +{ + //------------------------------------------------------------------------- + + /** creates a table of formulas (a "Multiple Operations Table"). + + <p>The specified formulas are repeated, with references to the + specified cells replaced by references to values in the first + column and/or row of the range.</p> + + @param aFormulaRange + the range that contains formula cells (modes + <const>TableOperationMode::ROW</const> or + <const>TableOperationMode::COLUMN</const>) or a single formula + cell (mode <const>TableOperationMode::BOTH</const>). + + @param nMode + specifies the calculation mode to fill the cells. + + @param aColumnCell + contains the address of the cell that is referenced by + formulas in a row (mode <const>TableOperationMode::ROW</const>) + or by the formula cell used for two value series (mode + <const>TableOperationMode::BOTH</const>). This parameter is not + used if mode is <const>TableOperationMode::COLUMN</const>. + + @param aRowCell + contains the address of the cell that is referenced by + formulas in a column (mode <const>TableOperationMode::COLUMN</const>) + or by the formula cell used for two value series (mode + <const>TableOperationMode::BOTH</const>). This parameter is not + used if mode is <const>TableOperationMode::ROW</const>. */ - void setTableOperation( [in] com::sun::star::table::CellRangeAddress aFormulaRange, - [in] com::sun::star::sheet::TableOperationMode nMode, - [in] com::sun::star::table::CellAddress aColumnCell, - [in] com::sun::star::table::CellAddress aRowCell ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void setTableOperation( + [in] com::sun::star::table::CellRangeAddress aFormulaRange, + [in] com::sun::star::sheet::TableOperationMode nMode, + [in] com::sun::star::table::CellAddress aColumnCell, + [in] com::sun::star::table::CellAddress aRowCell ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XNamedRange.idl b/offapi/com/sun/star/sheet/XNamedRange.idl index 9f5f0cbc8..2ed187ad0 100644 --- a/offapi/com/sun/star/sheet/XNamedRange.idl +++ b/offapi/com/sun/star/sheet/XNamedRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNamedRange.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:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,123 +58,88 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XNamedRange_idl__ -#define __com_sun_star_sheet_XNamedRange_idl__ - -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XNamedRange -/** represents a named range.@see com::sun::star::sheet::NamedRange + +#ifndef __com_sun_star_sheet_XNamedRange_idl__ +#define __com_sun_star_sheet_XNamedRange_idl__ + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to the settings of a named range in a spreadsheet + document. + + @see com::sun::star::sheet::NamedRange */ interface XNamedRange: com::sun::star::container::XNamed -{ - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XNamedRange::getContent - - // DocMerge from xml: method com::sun::star::sheet::XNamedRange::getContent +{ + //------------------------------------------------------------------------- + /** returns the content of the named range. - - - + <p>The content can be a reference to a cell or cell range - or any formula.</p> + or any formula expression.</p> */ - string getContent(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XNamedRange::setContent + string getContent(); + + //------------------------------------------------------------------------- + /** sets the content of the named range. - - - + <p>The content can be a reference to a cell or cell range - or any formula.</p> + or any formula expression.</p> */ - void setContent( [in] string aContent ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XNamedRange::getReferencePosition + void setContent( [in] string aContent ); + + //------------------------------------------------------------------------- + /** returns the position in the document which is used as a base for relative references in the content. */ - com::sun::star::table::CellAddress getReferencePosition(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XNamedRange::setReferencePosition + com::sun::star::table::CellAddress getReferencePosition(); + + //------------------------------------------------------------------------- + /** sets the position in the document which is used as a base for relative references in the content. */ - void setReferencePosition( [in] com::sun::star::table::CellAddress aReferencePosition ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XNamedRange::getType + void setReferencePosition( + [in] com::sun::star::table::CellAddress aReferencePosition ); + + //------------------------------------------------------------------------- + /** returns the type of the named range. + + <p>This is a combination of flags as defined in + <type>NamedRangeFlags</type>.</p> */ - long getType(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XNamedRange::setType + long getType(); + + //------------------------------------------------------------------------- + /** sets the type of the named range. - - - - <p>The type must be <val>0</val> or a combination of the - <type>NamedRangeFlag</type> constants and controls if the named - range is listed in dialogs prompting for special ranges.</p> + + @param nType + a combination of flags that specify the type of a named range, + as defined in <type>NamedRangeFlags</type>. */ - void setType( [in] long nType ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:46 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:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void setType( [in] long nType ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XNamedRanges.idl b/offapi/com/sun/star/sheet/XNamedRanges.idl index aa84a73e7..49ae610d8 100644 --- a/offapi/com/sun/star/sheet/XNamedRanges.idl +++ b/offapi/com/sun/star/sheet/XNamedRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNamedRanges.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:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,108 +58,119 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XNamedRanges_idl__ -#define __com_sun_star_sheet_XNamedRanges_idl__ - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - -#ifndef __com_sun_star_table_CellRangeAddress_idl__ -#include <com/sun/star/table/CellRangeAddress.idl> -#endif - -#ifndef __com_sun_star_sheet_Border_idl__ -#include <com/sun/star/sheet/Border.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XNamedRanges -/** represents a collection of named ranges.@see com::sun::star::sheet::NamedRanges + +#ifndef __com_sun_star_sheet_XNamedRanges_idl__ +#define __com_sun_star_sheet_XNamedRanges_idl__ + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +#ifndef __com_sun_star_table_CellRangeAddress_idl__ +#include <com/sun/star/table/CellRangeAddress.idl> +#endif + +#ifndef __com_sun_star_sheet_Border_idl__ +#include <com/sun/star/sheet/Border.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to the members in a collection of named ranges and to + insert and remove them. + + @see com::sun::star::sheet::NamedRanges + @see com::sun::star::sheet::NamedRange */ interface XNamedRanges: com::sun::star::container::XNameAccess -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XNamedRanges::addNewByName +{ + //------------------------------------------------------------------------- + /** adds a new named range to the collection. + + @param aName + the new name of the named range. + + @param aContent + the formula expression. + + <p>A cell range address is one possible content of a named + range.</p> + + @param aPosition + specifies the base address for relative cell references. + + @param nType + a combination of flags that specify the type of a named range, + as defined in <type>NamedRangeFlags</type>. + + <p>This parameter will be zero for any common named range.</p> */ - void addNewByName( [in] string aName, - [in] string aContent, - [in] com::sun::star::table::CellAddress aPosition, - [in] long nType ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XNamedRanges::addNewFromTitles - /** creates named ranges from titles in a cell range. - - - - <p>Names for the named ranges are taken from titles in the - top or bottom row, or the left or right column of the range. - The named ranges refer to single columns or rows in the inner + void addNewByName( + [in] string aName, + [in] string aContent, + [in] com::sun::star::table::CellAddress aPosition, + [in] long nType ); + + //------------------------------------------------------------------------- + + /** creates named cell ranges from titles in a cell range. + + <p>The names for the named ranges are taken from title cells in the + top or bottom row, or from the cells of the left or right column + of the range (depending on the parameter <const>aBorder</const>. + The named ranges refer to single columns or rows in the inner part of the original range, excluding the labels.</p> + + <p>Example: The source range is A1:B3. The named ranges shall be + created using row titles. This requires <member>Border::TOP</member> + for the second parameter. The method creates two named ranges. The + name of the first is equal to the content of cell A1 and contains the + range $Sheet.$A$2:$A$3 (excluding the title cell). The latter named + range is named using cell B1 and contains the cell range address + $Sheet.$B$2:$B$3.</p> + + @param aSource + the cell range used to create the named ranges. + + @param aBorder + specifies the location of the title cells. */ - void addNewFromTitles( [in] com::sun::star::table::CellRangeAddress aSource, - [in] com::sun::star::sheet::Border aBorder ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XNamedRanges::removeByName + void addNewFromTitles( + [in] com::sun::star::table::CellRangeAddress aSource, + [in] com::sun::star::sheet::Border aBorder ); + + //------------------------------------------------------------------------- + /** removes a named range from the collection. */ - void removeByName( [in] string aName ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XNamedRanges::outputList + void removeByName( [in] string aName ); + + //------------------------------------------------------------------------- + /** writes a list of all named ranges into the document. - - - - <p>The first column of the list contains the names. The second + + <p>The first column of the list contains the names. The second column contains the contents of the named ranges.</p> + + @param aOutputPosition + specifies the top left cell of the output range. */ - void outputList( [in] com::sun::star::table::CellAddress aOutputPosition ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void outputList( [in] com::sun::star::table::CellAddress aOutputPosition ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XPrintAreas.idl b/offapi/com/sun/star/sheet/XPrintAreas.idl index 0cb5258b7..83e183dbe 100644 --- a/offapi/com/sun/star/sheet/XPrintAreas.idl +++ b/offapi/com/sun/star/sheet/XPrintAreas.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPrintAreas.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:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,183 +58,144 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XPrintAreas_idl__ -#define __com_sun_star_sheet_XPrintAreas_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.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::XPrintAreas + +#ifndef __com_sun_star_sheet_XPrintAreas_idl__ +#define __com_sun_star_sheet_XPrintAreas_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.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 { + +//============================================================================= + /** represents a sheet which has print areas. - - - - - - - - - - - - - + @deprecated */ interface XPrintAreas: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XPrintAreas::getPrintAreas - - // DocMerge from idl: method com::sun::star::sheet::XPrintAreas::getPrintAreas - /** returns the print areas of the sheet. +{ + //------------------------------------------------------------------------- + + /** returns a sequence containing all print areas of the sheet. */ - sequence<com::sun::star::table::CellRangeAddress> getPrintAreas(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::setPrintAreas + sequence< com::sun::star::table::CellRangeAddress > getPrintAreas(); + + //------------------------------------------------------------------------- + /** sets the print areas of the sheet. - - - + <p>If none of the sheets in a document have print areas, - the whole sheets are printed.</p> + the whole sheets are printed. If any sheet contains print areas, + other sheets without print areas are not printed.</p> + + @param aPrintAreas + a sequence containing all print areas for this sheet. */ - void setPrintAreas( [in] sequence<com::sun::star::table::CellRangeAddress> aPrintAreas ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::getPrintTitleColumns - /** returns <TRUE/> if the title columns are repeated on - all subsequent print pages to the right. + void setPrintAreas( [in] sequence< com::sun::star::table::CellRangeAddress > aPrintAreas ); + + //------------------------------------------------------------------------- + + /** returns, whether the title columns are repeated on all subsequent + print pages to the right. */ - boolean getPrintTitleColumns(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::setPrintTitleColumns - /** specifies if the title columns are repeated on - all subsequent print pages to the right. + boolean getPrintTitleColumns(); + + //------------------------------------------------------------------------- + + /** specifies whether the title columns are repeated on all subsequent + print pages to the right. + + @param bPrintTitleColumns + if <TRUE/>, title columns are repeated on each page. */ - void setPrintTitleColumns( [in] boolean bPrintTitleColumns ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::getTitleColumns - /** returns the range of columns which are marked as - title columns. - - - + void setPrintTitleColumns( [in] boolean bPrintTitleColumns ); + + //------------------------------------------------------------------------- + + /** returns the range that is specified as title columns range. + <p>Title columns can be automatically repeated on all subsequent - print pages to the right.</p> + print pages to the right, using + <member>XPrintAreas::setPrintTitleColumns</member>.</p> + + @returns + the range of columns that is specified as title columns range. */ - com::sun::star::table::CellRangeAddress getTitleColumns(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::setTitleColumns - /** sets the range of columns marked as title columns. - - - - <p>The rows of the - <type scope="com::sun::star::table">CellRangeAddress</type> - are ignored.</p> - + com::sun::star::table::CellRangeAddress getTitleColumns(); + + //------------------------------------------------------------------------- + + /** specifies a range of columns as title columns range. + + <p>The rows of the passed range are ignored.</p> + <p>Title columns can be automatically repeated on all subsequent - print pages to the right.</p> + print pages to the right, using + <member>XPrintAreas::setPrintTitleColumns</member>.</p> + + @param aTitleColumns + the title columns range. */ - void setTitleColumns( [in] com::sun::star::table::CellRangeAddress aTitleColumns ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::getPrintTitleRows - /** returns <TRUE/> if the title rows are repeated on - all subsequent print pages to the bottom. + void setTitleColumns( [in] com::sun::star::table::CellRangeAddress aTitleColumns ); + + //------------------------------------------------------------------------- + + /** returns, whether the title rows are repeated on all subsequent + print pages to the bottom. */ - boolean getPrintTitleRows(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::setPrintTitleRows - /** specifies if the title rows are repeated on - all subsequent print pages to the bottom. + boolean getPrintTitleRows(); + + //------------------------------------------------------------------------- + + /** specifies whether the title rows are repeated on all subsequent + print pages to the bottom. + + @param bPrintTitleRows + if <TRUE/>, title rows are repeated on each page. */ - void setPrintTitleRows( [in] boolean bPrintTitleRows ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::getTitleRows - /** returns the range of rows which are marked as - title rows. - - - + void setPrintTitleRows( [in] boolean bPrintTitleRows ); + + //------------------------------------------------------------------------- + + /** returns the range that is specified as title rows range. + <p>Title rows can be automatically repeated on all subsequent - print pages to the bottom.</p> + print pages to the bootom, using + <member>XPrintAreas::setPrintTitleRows</member>.</p> + + @returns + the range of rows that is specified as title rows range. */ - com::sun::star::table::CellRangeAddress getTitleRows(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::setTitleRows - /** sets the range of rows marked as title rows. - - - - <p>The columns of the - <type scope="com::sun::star::table">CellRangeAddress</type> - are ignored.</p> - + com::sun::star::table::CellRangeAddress getTitleRows(); + + //------------------------------------------------------------------------- + + /** specifies a range of rows as title rows range. + + <p>The columns of the passed range are ignored.</p> + <p>Title rows can be automatically repeated on all subsequent - print pages to the bottom.</p> + print pages to the bottom, using + <member>XPrintAreas::setPrintTitleRows</member>.</p> + + @param aTitleRows + the title rows range. */ - void setTitleRows( [in] com::sun::star::table::CellRangeAddress aTitleRows ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:40 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void setTitleRows( [in] com::sun::star::table::CellRangeAddress aTitleRows ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XRangeSelection.idl b/offapi/com/sun/star/sheet/XRangeSelection.idl index 2de9531cb..df96e5b28 100644 --- a/offapi/com/sun/star/sheet/XRangeSelection.idl +++ b/offapi/com/sun/star/sheet/XRangeSelection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRangeSelection.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-06-11 22:18:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,6 +79,8 @@ interface XRangeSelectionChangeListener; //============================================================================= /** allows to let the user to select a cell range. + + @see com::sun::star::sheet::SpreadsheetView */ interface XRangeSelection: com::sun::star::uno::XInterface { @@ -121,8 +123,6 @@ interface XRangeSelection: com::sun::star::uno::XInterface //============================================================================= }; }; }; }; - #endif - diff --git a/offapi/com/sun/star/sheet/XRangeSelectionChangeListener.idl b/offapi/com/sun/star/sheet/XRangeSelectionChangeListener.idl index 0f310f000..bdbb14f1d 100644 --- a/offapi/com/sun/star/sheet/XRangeSelectionChangeListener.idl +++ b/offapi/com/sun/star/sheet/XRangeSelectionChangeListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRangeSelectionChangeListener.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,6 +77,8 @@ //============================================================================= /** allows notification when the selected range is changed. + + @see com::sun::star::sheet::XRangeSelection */ interface XRangeSelectionChangeListener: com::sun::star::lang::XEventListener { diff --git a/offapi/com/sun/star/sheet/XRangeSelectionListener.idl b/offapi/com/sun/star/sheet/XRangeSelectionListener.idl index fd1550c46..aece5cf61 100644 --- a/offapi/com/sun/star/sheet/XRangeSelectionListener.idl +++ b/offapi/com/sun/star/sheet/XRangeSelectionListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRangeSelectionListener.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,6 +77,8 @@ //============================================================================= /** allows notification when range selection is completed or aborted. + + @see com::sun::star::sheet::XRangeSelection */ interface XRangeSelectionListener: com::sun::star::lang::XEventListener { diff --git a/offapi/com/sun/star/sheet/XRecentFunctions.idl b/offapi/com/sun/star/sheet/XRecentFunctions.idl index 65b7bb2b3..7743941c7 100644 --- a/offapi/com/sun/star/sheet/XRecentFunctions.idl +++ b/offapi/com/sun/star/sheet/XRecentFunctions.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRecentFunctions.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:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,85 +58,60 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XRecentFunctions_idl__ -#define __com_sun_star_sheet_XRecentFunctions_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XRecentFunctions -/** represents a list of recently used functions.@see com::sun::star::sheet::RecentFunctions + +#ifndef __com_sun_star_sheet_XRecentFunctions_idl__ +#define __com_sun_star_sheet_XRecentFunctions_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to a list of recently used functions. + + @see com::sun::star::sheet::RecentFunctions */ interface XRecentFunctions: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XRecentFunctions::getRecentFunctionIds - - // DocMerge from idl: method com::sun::star::sheet::XRecentFunctions::getRecentFunctionIds - /** returns a sequence of those functions that were - most recently used. - - <P>The functions are represented by their identifiers.</P> +{ + //------------------------------------------------------------------------- + + /** returns a sequence of those functions that were most recently used. + + <P>The functions are represented by their identifiers.</P> + + @returns + the sequence of function identifiers most recently used. */ - sequence<long> getRecentFunctionIds(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XRecentFunctions::setRecentFunctionIds + sequence< long > getRecentFunctionIds(); + + //------------------------------------------------------------------------- + /** sets the list of those functions that were most recently used. - + <p>The functions are represented by their identifiers.</p> + + @param aRecentFunctionIds + the sequence of function identifiers most recently used. */ - void setRecentFunctionIds( [in] sequence<long> aRecentFunctionIds ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XRecentFunctions::getMaxRecentFunctions - /** returns the maximum number of entries that will be stored as recent functions. + void setRecentFunctionIds( [in] sequence< long > aRecentFunctionIds ); + + //------------------------------------------------------------------------- + + /** returns the maximum number of entries that will be stored as + recently used functions. */ - long getMaxRecentFunctions(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + long getMaxRecentFunctions(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XResultListener.idl b/offapi/com/sun/star/sheet/XResultListener.idl index 791c68ccc..b6c62e608 100644 --- a/offapi/com/sun/star/sheet/XResultListener.idl +++ b/offapi/com/sun/star/sheet/XResultListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XResultListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,57 +58,41 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XResultListener_idl__ -#define __com_sun_star_sheet_XResultListener_idl__ - -#ifndef __com_sun_star_lang_XEventListener_idl__ -#include <com/sun/star/lang/XEventListener.idl> -#endif - -#ifndef __com_sun_star_sheet_ResultEvent_idl__ -#include <com/sun/star/sheet/ResultEvent.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XResultListener -/** allows notification when new values are available. + +#ifndef __com_sun_star_sheet_XResultListener_idl__ +#define __com_sun_star_sheet_XResultListener_idl__ + +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include <com/sun/star/lang/XEventListener.idl> +#endif + +#ifndef __com_sun_star_sheet_ResultEvent_idl__ +#include <com/sun/star/sheet/ResultEvent.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** allows notification when a new volatile function result is available. + + @see com::sun::star::sheet::XVolatileResult */ interface XResultListener: com::sun::star::lang::XEventListener -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XResultListener::modified +{ + //------------------------------------------------------------------------- + /** is called when a new value is available. */ - void modified( [in] com::sun::star::sheet::ResultEvent aEvent ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void modified( [in] com::sun::star::sheet::ResultEvent aEvent ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XScenario.idl b/offapi/com/sun/star/sheet/XScenario.idl index 6443428a8..0cf17b095 100644 --- a/offapi/com/sun/star/sheet/XScenario.idl +++ b/offapi/com/sun/star/sheet/XScenario.idl @@ -2,9 +2,9 @@ * * $RCSfile: XScenario.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:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,115 +58,72 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XScenario_idl__ -#define __com_sun_star_sheet_XScenario_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.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::XScenario -/** represents something that can be a scenario. - - - - - - - - - - - - - +#ifndef __com_sun_star_sheet_XScenario_idl__ +#define __com_sun_star_sheet_XScenario_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.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 access to the settings of a scenario sheet. + + @see com::sun::star::sheet::Spreadsheet + @deprecated */ interface XScenario: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XScenario::getIsScenario - /** returns <TRUE/> if this is a scenario. +{ + //------------------------------------------------------------------------- + + /** returns <TRUE/> if the current object is a scenario. */ - boolean getIsScenario(); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XScenario::getScenarioComment - - // DocMerge from xml: method com::sun::star::sheet::XScenario::getScenarioComment + boolean getIsScenario(); + + //------------------------------------------------------------------------- + /** returns the comment for the scenario. */ - string getScenarioComment(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XScenario::setScenarioComment - /** sets the comment for the scenario. + string getScenarioComment(); + + //------------------------------------------------------------------------- + + /** sets a new comment for the scenario. */ - void setScenarioComment( [in] string aScenarioComment ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XScenario::addRanges + void setScenarioComment( [in] string aScenarioComment ); + + //------------------------------------------------------------------------- + /** adds more ranges to the scenario. */ - void addRanges( [in] sequence<com::sun::star::table::CellRangeAddress> aRanges ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XScenario::apply + void addRanges( + [in] sequence< com::sun::star::table::CellRangeAddress > aRanges ); + + //------------------------------------------------------------------------- + /** applies the scenario. - - - + <p>The contents of the scenario ranges are copied into the first non-scenario sheet which is in front of the sheet containing the scenario by itself.</p> */ - void apply(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:40 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void apply(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XScenarios.idl b/offapi/com/sun/star/sheet/XScenarios.idl index 5c155419f..5a0fadae4 100644 --- a/offapi/com/sun/star/sheet/XScenarios.idl +++ b/offapi/com/sun/star/sheet/XScenarios.idl @@ -2,9 +2,9 @@ * * $RCSfile: XScenarios.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:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,72 +58,61 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XScenarios_idl__ -#define __com_sun_star_sheet_XScenarios_idl__ - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.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::XScenarios -/** represents a collection of scenarios.@see com::sun::star::sheet::Scenarios + +#ifndef __com_sun_star_sheet_XScenarios_idl__ +#define __com_sun_star_sheet_XScenarios_idl__ + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.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 access via name to the scenarios in a collection and inserting + and removing scenarios. + + @see com::sun::star::sheet::Scenarios + @see com::sun::star::sheet::Spreadsheet */ interface XScenarios: com::sun::star::container::XNameAccess -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XScenarios::addNewByName +{ + //------------------------------------------------------------------------- + /** creates a new scenario and adds it to the collection. + + @param aName + the name of the scenario (used i.e. for collection access). + + @param aRanges + the cell ranges contained in the scenario. + + @param aComment + the user defined comment for the scenario. */ - void addNewByName( [in] string aName, - [in] sequence<com::sun::star::table::CellRangeAddress> aRanges, - [in] string aComment ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XScenarios::removeByName + void addNewByName( + [in] string aName, + [in] sequence< com::sun::star::table::CellRangeAddress > aRanges, + [in] string aComment ); + + //------------------------------------------------------------------------- + /** removes a scenario from the collection. */ - void removeByName( [in] string aName ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void removeByName( [in] string aName ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XScenariosSupplier.idl b/offapi/com/sun/star/sheet/XScenariosSupplier.idl index be2fdf93a..005455b8e 100644 --- a/offapi/com/sun/star/sheet/XScenariosSupplier.idl +++ b/offapi/com/sun/star/sheet/XScenariosSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XScenariosSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,57 +58,41 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XScenariosSupplier_idl__ -#define __com_sun_star_sheet_XScenariosSupplier_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_XScenarios_idl__ -#include <com/sun/star/sheet/XScenarios.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XScenariosSupplier + +#ifndef __com_sun_star_sheet_XScenariosSupplier_idl__ +#define __com_sun_star_sheet_XScenariosSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_XScenarios_idl__ +#include <com/sun/star/sheet/XScenarios.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** provides access to a collection of scenarios. */ interface XScenariosSupplier: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XScenariosSupplier::getScenarios +{ + //------------------------------------------------------------------------- + /** returns the collection of scenarios. + + @see com::sun::star::sheet::Scenarios */ - com::sun::star::sheet::XScenarios getScenarios(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::sheet::XScenarios getScenarios(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetAnnotation.idl b/offapi/com/sun/star/sheet/XSheetAnnotation.idl index 4fb5eec00..69860a220 100644 --- a/offapi/com/sun/star/sheet/XSheetAnnotation.idl +++ b/offapi/com/sun/star/sheet/XSheetAnnotation.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetAnnotation.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:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,103 +58,68 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetAnnotation_idl__ -#define __com_sun_star_sheet_XSheetAnnotation_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetAnnotation -/** represents an annotation on a sheet.@see com::sun::star::sheet::CellAnnotation + +#ifndef __com_sun_star_sheet_XSheetAnnotation_idl__ +#define __com_sun_star_sheet_XSheetAnnotation_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to query data of the annotation and to show and + hide it. + + @see com::sun::star::sheet::CellAnnotation */ interface XSheetAnnotation: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::sheet::XSheetAnnotation::getPosition - /** @returns - the position of the annotation in the document. +{ + //------------------------------------------------------------------------- + + /** returns the position of cell in the spreadsheet document that + contains this annotation. */ - com::sun::star::table::CellAddress getPosition(); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetAnnotation::getAuthor - - // DocMerge from idl: method com::sun::star::sheet::XSheetAnnotation::getAuthor - /** @returns - the name of the user who last changed the annotation. + com::sun::star::table::CellAddress getPosition(); + + //------------------------------------------------------------------------- + + /** returns the name of the user who last changed the annotation. */ - string getAuthor(); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetAnnotation::getDate - - // DocMerge from idl: method com::sun::star::sheet::XSheetAnnotation::getDate - /** @returns - a formatted string for the date when the annotation was last changed. + string getAuthor(); + + //------------------------------------------------------------------------- + + /** returns a formatted string representing the date when the + annotation was last changed. */ - string getDate(); - - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::sheet::XSheetAnnotation::getIsVisible - /** @returns - whether the annotation is permanently visible or not. + string getDate(); + + //------------------------------------------------------------------------- + + /** returns, whether the annotation is permanently visible. */ - boolean getIsVisible(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetAnnotation::setIsVisible - /** specifies if the annotation is permanently visible. + boolean getIsVisible(); + + //------------------------------------------------------------------------- + + /** specifies whether the annotation is permanently visible. */ - void setIsVisible( [in] boolean bIsVisible ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void setIsVisible( [in] boolean bIsVisible ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetAnnotationAnchor.idl b/offapi/com/sun/star/sheet/XSheetAnnotationAnchor.idl index b7f0ef01e..7d790b669 100644 --- a/offapi/com/sun/star/sheet/XSheetAnnotationAnchor.idl +++ b/offapi/com/sun/star/sheet/XSheetAnnotationAnchor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetAnnotationAnchor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,57 +58,42 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetAnnotationAnchor_idl__ -#define __com_sun_star_sheet_XSheetAnnotationAnchor_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_XSheetAnnotation_idl__ -#include <com/sun/star/sheet/XSheetAnnotation.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetAnnotationAnchor -/** represents the anchor of a sheet annotation. + +#ifndef __com_sun_star_sheet_XSheetAnnotationAnchor_idl__ +#define __com_sun_star_sheet_XSheetAnnotationAnchor_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetAnnotation_idl__ +#include <com/sun/star/sheet/XSheetAnnotation.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to a cell annotation attached to a spreadsheet cell. + + @see com::sun::star::sheet::SheetCell + @see com::sun::star::sheet::CellAnnotation */ interface XSheetAnnotationAnchor: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetAnnotationAnchor::getAnnotation +{ + //------------------------------------------------------------------------- + /** returns the annotation at this anchor. */ - com::sun::star::sheet::XSheetAnnotation getAnnotation(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::sheet::XSheetAnnotation getAnnotation(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetAnnotations.idl b/offapi/com/sun/star/sheet/XSheetAnnotations.idl index 27eebcc1d..4525912bc 100644 --- a/offapi/com/sun/star/sheet/XSheetAnnotations.idl +++ b/offapi/com/sun/star/sheet/XSheetAnnotations.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetAnnotations.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:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,72 +58,67 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetAnnotations_idl__ -#define __com_sun_star_sheet_XSheetAnnotations_idl__ - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetAnnotations -/** represents a collection of annotations on a sheet.@see com::sun::star::sheet::CellAnnotations + +#ifndef __com_sun_star_sheet_XSheetAnnotations_idl__ +#define __com_sun_star_sheet_XSheetAnnotations_idl__ + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to access cell annotations via index and to + insert and remove annotations. + + @see com::sun::star::sheet::CellAnnotation + @see com::sun::star::sheet::SheetCell */ interface XSheetAnnotations: com::sun::star::container::XIndexAccess -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetAnnotations::insertNew - /** creates and inserts a new annotation and adds - it to the collection. +{ + //------------------------------------------------------------------------- + + /** creates a new annotation. + + <p>This method creates a new annotation object, attaches it to the + specified cell and inserts it into the collection.</p> + + @param aPosition + contains the address of the cell thta will contain the + annotation. + + @param aText + contains the annotation text. */ - void insertNew( [in] com::sun::star::table::CellAddress aPosition, - [in] string aText ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetAnnotations::removeByIndex - /** removes an annotation from the collection. + void insertNew( + [in] com::sun::star::table::CellAddress aPosition, + [in] string aText ); + + //------------------------------------------------------------------------- + + /** removes a cell annotation from the collection. + + <p>This method removes the annotation from its cell and from the + collection.</p> + + @param nIndex + is the index of the annotation in the collection. */ - void removeByIndex( [in] long nIndex ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void removeByIndex( [in] long nIndex ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetAnnotationsSupplier.idl b/offapi/com/sun/star/sheet/XSheetAnnotationsSupplier.idl index 4696cedfd..134770365 100644 --- a/offapi/com/sun/star/sheet/XSheetAnnotationsSupplier.idl +++ b/offapi/com/sun/star/sheet/XSheetAnnotationsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetAnnotationsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * 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,57 +58,41 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetAnnotationsSupplier_idl__ -#define __com_sun_star_sheet_XSheetAnnotationsSupplier_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_XSheetAnnotations_idl__ -#include <com/sun/star/sheet/XSheetAnnotations.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetAnnotationsSupplier -/** enables access to a collection of annotations. + +#ifndef __com_sun_star_sheet_XSheetAnnotationsSupplier_idl__ +#define __com_sun_star_sheet_XSheetAnnotationsSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetAnnotations_idl__ +#include <com/sun/star/sheet/XSheetAnnotations.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to a collection of cell annotations. */ interface XSheetAnnotationsSupplier: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetAnnotationsSupplier::getAnnotations - /** returns the collection of annotations. +{ + //------------------------------------------------------------------------- + + /** returns the collection of cell annotations. + + @see com::sun::star::sheet::CellAnnotations */ - com::sun::star::sheet::XSheetAnnotations getAnnotations(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::sheet::XSheetAnnotations getAnnotations(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetAuditing.idl b/offapi/com/sun/star/sheet/XSheetAuditing.idl index cb224cfa2..9a46db6a6 100644 --- a/offapi/com/sun/star/sheet/XSheetAuditing.idl +++ b/offapi/com/sun/star/sheet/XSheetAuditing.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetAuditing.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * 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,110 +58,101 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetAuditing_idl__ -#define __com_sun_star_sheet_XSheetAuditing_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetAuditing -/** represents auditing functions of a sheet. + +#ifndef __com_sun_star_sheet_XSheetAuditing_idl__ +#define __com_sun_star_sheet_XSheetAuditing_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to access auditing (detective) features in a + spreadsheet. */ interface XSheetAuditing: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetAuditing::hideDependents - /** removes arrows for one level of dependents of a cell. +{ + //------------------------------------------------------------------------- + + /** removes arrows for one level of dependents of a formula cell. + + <p>If the method is executed again for the same cell, the previous + level of dependent cells is removed.</p> + + @param aPosition + the address of the formula cell. */ - boolean hideDependents( [in] com::sun::star::table::CellAddress aPosition ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetAuditing::hidePrecedents - /** removes arrows for one level of precedents of a cell. + boolean hideDependents( [in] com::sun::star::table::CellAddress aPosition ); + + //------------------------------------------------------------------------- + + /** removes arrows for one level of precedents of a formula cell. + + <p>If the method is executed again for the same cell, the previous + level of dependent cells is removed.</p> + + @param aPosition + the address of the formula cell. */ - boolean hidePrecedents( [in] com::sun::star::table::CellAddress aPosition ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetAuditing::showDependents - /** draws arrows between a cell and its dependent formulas. - - - - <p>If the method is executed again for the same cell, another level - of dependent cells is marked.</p> + boolean hidePrecedents( [in] com::sun::star::table::CellAddress aPosition ); + + //------------------------------------------------------------------------- + + /** draws arrows between a formula cell and its dependents. + + <p>If the method is executed again for the same cell, the next + level of dependent cells is marked.</p> + + @param aPosition + the address of the formula cell. */ - boolean showDependents( [in] com::sun::star::table::CellAddress aPosition ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetAuditing::showPrecedents + boolean showDependents( [in] com::sun::star::table::CellAddress aPosition ); + + //------------------------------------------------------------------------- + /** draws arrows between a formula cell and its precedents. - - - - <p>If the method is executed again for the same cell, another level - of precedent cells is marked.</p> + + <p>If the method is executed again for the same cell, the next + level of dependent cells is marked.</p> + + @param aPosition + the address of the formula cell. */ - boolean showPrecedents( [in] com::sun::star::table::CellAddress aPosition ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetAuditing::showErrors + boolean showPrecedents( [in] com::sun::star::table::CellAddress aPosition ); + + //------------------------------------------------------------------------- + /** draws arrows between a formula cell containing an error and the cells causing the error. */ - boolean showErrors( [in] com::sun::star::table::CellAddress aPosition ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetAuditing::showInvalid + boolean showErrors( [in] com::sun::star::table::CellAddress aPosition ); + + //------------------------------------------------------------------------- + /** marks all cells containing invalid values. */ - boolean showInvalid(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetAuditing::clearArrows - /** removes all arrows. + boolean showInvalid(); + + //------------------------------------------------------------------------- + + /** removes all auditing arrows from the spreadsheet. */ - void clearArrows(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void clearArrows(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetCellCursor.idl b/offapi/com/sun/star/sheet/XSheetCellCursor.idl index 0d610c585..f66f5687e 100644 --- a/offapi/com/sun/star/sheet/XSheetCellCursor.idl +++ b/offapi/com/sun/star/sheet/XSheetCellCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetCellCursor.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,113 +58,90 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetCellCursor_idl__ -#define __com_sun_star_sheet_XSheetCellCursor_idl__ - -#ifndef __com_sun_star_sheet_XSheetCellRange_idl__ -#include <com/sun/star/sheet/XSheetCellRange.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetCellCursor -/** represents a cursor which can select a cell range.@see com::sun::star::sheet::SheetCellCursor + +#ifndef __com_sun_star_sheet_XSheetCellCursor_idl__ +#define __com_sun_star_sheet_XSheetCellCursor_idl__ + +#ifndef __com_sun_star_sheet_XSheetCellRange_idl__ +#include <com/sun/star/sheet/XSheetCellRange.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides advanced methods to control the position of a cursor in a + spreadsheet. + + @see com::sun::star::sheet::SheetCellCursor */ interface XSheetCellCursor: com::sun::star::sheet::XSheetCellRange -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetCellCursor::collapseToCurrentRegion - /** collapses the cursor into the region containing the cells - to which it currently points. - - - +{ + //------------------------------------------------------------------------- + + /** expands the cursor into the region containing the cells to which + it currently points. + <p>A region is a cell range bounded by empty cells.</p> */ - void collapseToCurrentRegion(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetCellCursor::collapseToCurrentArray - /** collapses the cursor into the range of the array formula to which + void collapseToCurrentRegion(); + + //------------------------------------------------------------------------- + + /** collapses the cursor into the range of the array formula to which it is currently pointing. - - - - <p>If the cursor does not point to a range with an array formula, it - is left unchanged.</p> + + <p>To get the correct result, the top left cell of the original + cursor must point to any cell containing an array formula. + If not, the cursor is left unchanged.</p> */ - void collapseToCurrentArray(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetCellCursor::collapseToMergedArea - /** collapses the cursor into the range of merged cells. - - - - <p>If the cursor does not point to a range with merged cells, it + void collapseToCurrentArray(); + + //------------------------------------------------------------------------- + + /** expands the cursor to merged cell ranges. + + <p>Expands the current cursor range in a way so that all merged + cell ranges intersecting the current range will fit completely. + If the cursor does not point to any range with merged cells, it is left unchanged.</p> */ - void collapseToMergedArea(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetCellCursor::expandToEntireColumns - /** expands the cursor to include the columns of - the cells to which it is currently pointing. + void collapseToMergedArea(); + + //------------------------------------------------------------------------- + + /** expands the cursor to include the entire columns of the cells + to which it is currently pointing. */ - void expandToEntireColumns(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetCellCursor::expandToEntireRows - /** expands the cursor to include the rows of - the cells to which it is currently pointing. + void expandToEntireColumns(); + + //------------------------------------------------------------------------- + + /** expands the cursor to include the entire rows of the cells to + which it is currently pointing. */ - void expandToEntireRows(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetCellCursor::collapseToSize + void expandToEntireRows(); + + //------------------------------------------------------------------------- + /** changes the size of a cursor range. + + <p>The top left cell of the cursor keeps unmodified. </p> + + @param nColumns + the number of columns of the new cursor range. + @param nRows + the number of rows of the new cursor range. */ - void collapseToSize( [in] long nColumns, - [in] long nRows ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void collapseToSize( [in] long nColumns, [in] long nRows ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetCellRange.idl b/offapi/com/sun/star/sheet/XSheetCellRange.idl index c00f63f07..ab3cf56ce 100644 --- a/offapi/com/sun/star/sheet/XSheetCellRange.idl +++ b/offapi/com/sun/star/sheet/XSheetCellRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetCellRange.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,67 +58,47 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetCellRange_idl__ -#define __com_sun_star_sheet_XSheetCellRange_idl__ - -#ifndef __com_sun_star_table_XCellRange_idl__ -#include <com/sun/star/table/XCellRange.idl> -#endif - -//============================================================================= - - module com { module sun { module star { module sheet { - -interface XSpreadsheet; - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetCellRange -/** represents a cell range in a sheet.@see com::sun::star::sheet::SheetCellRange + +#ifndef __com_sun_star_sheet_XSheetCellRange_idl__ +#define __com_sun_star_sheet_XSheetCellRange_idl__ + +#ifndef __com_sun_star_table_XCellRange_idl__ +#include <com/sun/star/table/XCellRange.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +interface XSpreadsheet; + +//============================================================================= + +/** provides access to the spreadsheet that contains a cell range. + + @see com::sun::star::sheet::SheetCellRange */ interface XSheetCellRange: com::sun::star::table::XCellRange -{ - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::sheet::XSheetCellRange::getSpreadsheet - /** returns the spreadsheet interface which contains - the cell range. - - @returns - a <type>Spreadsheet</type> object. - - @see com::sun::star::sheet::SheetCellRange - @see com::sun::star::sheet::SheetCellRanges +{ + //------------------------------------------------------------------------- + + /** returns the spreadsheet interface which contains the cell range. + + @returns + a <type>Spreadsheet</type> object. + + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SheetCellRanges */ - XSpreadsheet getSpreadsheet(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::sheet::XSpreadsheet getSpreadsheet(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl b/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl index 3c8d2768c..520be0615 100644 --- a/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl +++ b/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetCellRangeContainer.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * 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,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetCellRangeContainer_idl__ #define __com_sun_star_sheet_XSheetCellRangeContainer_idl__ @@ -69,53 +70,86 @@ #include <com/sun/star/table/CellRangeAddress.idl> #endif -#ifndef __com_sun_star_uno_RuntimeException_idl__ -#include <com/sun/star/uno/RuntimeException.idl> -#endif - -#ifndef __com_sun_star_lang_WrappedTargetException_idl__ -#include <com/sun/star/lang/WrappedTargetException.idl> -#endif - #ifndef __com_sun_star_container_NoSuchElementException_idl__ #include <com/sun/star/container/NoSuchElementException.idl> #endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -/** represents multiple cell ranges.@see com::sun::star::sheet::SheetCellRanges +/** provides methods to access cell ranges in a collection via index and + to add and remove cell ranges. + + @see com::sun::star::sheet::SheetCellRanges */ interface XSheetCellRangeContainer: com::sun::star::sheet::XSheetCellRanges { - /** add the given range to the cell ranges. + //------------------------------------------------------------------------- + + /** adds the given range to the collection of cell ranges. + + @param aCellRangeAddress + contains the address of the new range. + @param bMergeRanges - With the second parameter is it possible to define how the range - should be added. To merge the ranges takes more time, but the memory - usage is lower. + defines how the range should be added. To merge the ranges + takes more time, but the memory usage is lower. */ - void addRangeAddress( [in] com::sun::star::table::CellRangeAddress aCellRangeAddress, [in] boolean bMergeRanges ); + void addRangeAddress( + [in] com::sun::star::table::CellRangeAddress aCellRangeAddress, + [in] boolean bMergeRanges ); + + //------------------------------------------------------------------------- + + /** removes the given range from the collection of cell ranges. - /** remove the given range from the cell ranges + @param aCellRangeAddress + contains the address of the range to be removed. + + <p>The specified range must fit exactly to an element of the + collection. The method does not try to shorten a range.</p> + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if the collection does not contain the specified range. */ - void removeRangeAddress( [in] com::sun::star::table::CellRangeAddress aCellRangeAddress ) - raises( com::sun::star::container::NoSuchElementException ); + void removeRangeAddress( + [in] com::sun::star::table::CellRangeAddress aCellRangeAddress ) + raises( com::sun::star::container::NoSuchElementException ); + + //------------------------------------------------------------------------- + + /** adds the given ranges to the collection of cell ranges. + + @param aCellRangeAddresses + contains a sequence of addresses of all new ranges. - /** add the given ranges to the cell ranges. @param bMergeRanges - With the second parameter is it possible to define how the ranges - should be added. To merge the ranges takes more time, but the memory - usage is lower. + defines how the ranges should be added. To merge the ranges + takes more time, but the memory usage is lower. */ - void addRangeAddresses( [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses, [in] boolean bMergeRanges ); + void addRangeAddresses( + [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses, + [in] boolean bMergeRanges ); - /** remove the given ranges from the cell ranges. + //------------------------------------------------------------------------- + + /** removes the given ranges from the collection of cell ranges. + + @param aCellRangeAddresses + contains a sequence of addresses of all ranges to be removed. + + <p>All specified ranges must fit exactly to elements of the + collection. The method does not try to shorten ranges.</p> + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if the collection does not contain any of the specified ranges. */ - void removeRangeAddresses( [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses ) - raises( com::sun::star::container::NoSuchElementException); + void removeRangeAddresses( + [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses ) + raises( com::sun::star::container::NoSuchElementException); }; @@ -124,3 +158,4 @@ interface XSheetCellRangeContainer: com::sun::star::sheet::XSheetCellRanges }; }; }; }; #endif + 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 + diff --git a/offapi/com/sun/star/sheet/XSheetCondition.idl b/offapi/com/sun/star/sheet/XSheetCondition.idl index c082b4848..1d8202944 100644 --- a/offapi/com/sun/star/sheet/XSheetCondition.idl +++ b/offapi/com/sun/star/sheet/XSheetCondition.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetCondition.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:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,157 +58,109 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetCondition_idl__ -#define __com_sun_star_sheet_XSheetCondition_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_ConditionOperator_idl__ -#include <com/sun/star/sheet/ConditionOperator.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetCondition -/** represents a condition in conditional formats or validation.@see com::sun::star::sheet::TableValidation - @see com::sun::star::sheet::TableConditionalEntry + +#ifndef __com_sun_star_sheet_XSheetCondition_idl__ +#define __com_sun_star_sheet_XSheetCondition_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_ConditionOperator_idl__ +#include <com/sun/star/sheet/ConditionOperator.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to access the settings of a condition in a + conditional format or data validation. + + @see com::sun::star::sheet::TableConditionalEntry + @see com::sun::star::sheet::TableValidation */ interface XSheetCondition: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::getOperator +{ + //------------------------------------------------------------------------- + /** returns the operator in the condition. */ - com::sun::star::sheet::ConditionOperator getOperator(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::setOperator + com::sun::star::sheet::ConditionOperator getOperator(); + + //------------------------------------------------------------------------- + /** sets the operator in the condition. */ - void setOperator( [in] com::sun::star::sheet::ConditionOperator nOperator ); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetCondition::getFormula1 - - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::getFormula1 - /** returns either the comparison value, which is used in - the condition, or the first value if two values are needed for - the operator. - - - - <p>This can be a formula, a numeric constant, or a - string constant in quotes.</p> + void setOperator( + [in] com::sun::star::sheet::ConditionOperator nOperator ); + + //------------------------------------------------------------------------- + + /** returns either the comparison value, which is used in the condition, + or the first value if two values are needed for the operator. + + @returns + a formula, a numeric constant, or a string constant in quotes. */ - string getFormula1(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::setFormula1 - /** sets either the comparison value, which is used in - the condition, or the first value if two values are needed for - the operator. - - - - <p>This can be a formula, a numeric constant, or a - string constant in quotes.</p> + string getFormula1(); + + //------------------------------------------------------------------------- + + /** sets either the comparison value, which is used in the condition, + or the first value if two values are needed for the operator. + + @param aFormula1 + a formula, a numeric constant, or a string constant in quotes. */ - void setFormula1( [in] string aFormula1 ); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetCondition::getFormula2 - - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::getFormula2 - /** if two values are needed for the operator, this method returns + void setFormula1( [in] string aFormula1 ); + + //------------------------------------------------------------------------- + + /** if two values are needed for the operator, this method returns the second one. - - - - <p>this can be a formula, a numeric constant, or a string constant - in quotes. The operators <const>ConditionOperator::BETWEEN</const> - and <const>ConditionOperator::NOT_BETWEEN</const> need two values - each.</p> + + @returns + a formula, a numeric constant, or a string constant in quotes. */ - string getFormula2(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::setFormula2 - /** if two values are needed for the operator, this method sets + string getFormula2(); + + //------------------------------------------------------------------------- + + /** if two values are needed for the operator, this method sets the second one. - - - - <p>This can be a formula, a numeric constant, or a string constant - in quotes. The operators <const>ConditionOperator::BETWEEN</const> - and <const>ConditionOperator::NOT_BETWEEN</const> need two values - each.</p> + + @param aFormula2 + a formula, a numeric constant, or a string constant in quotes. */ - void setFormula2( [in] string aFormula2 ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::getSourcePosition - /** returns the position in the document which - is used as a base for relative references in the formulas. + void setFormula2( [in] string aFormula2 ); + + //------------------------------------------------------------------------- + + /** returns the position in the document which is used as a base for + relative references in the formulas. */ - com::sun::star::table::CellAddress getSourcePosition(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::setSourcePosition - /** sets the position in the document which is used - as a base for relative references in the formulas. + com::sun::star::table::CellAddress getSourcePosition(); + + //------------------------------------------------------------------------- + + /** sets the position in the document which is used as a base for + relative references in the formulas. */ - void setSourcePosition( [in] com::sun::star::table::CellAddress aSourcePosition ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - 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 + void setSourcePosition( + [in] com::sun::star::table::CellAddress aSourcePosition ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl b/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl index 8abc0a1a3..14c5da8ee 100644 --- a/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl +++ b/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetConditionalEntries.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,80 +58,76 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__ -#define __com_sun_star_sheet_XSheetConditionalEntries_idl__ - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> -#endif - -#ifndef __com_sun_star_beans_PropertyValue_idl__ -#include <com/sun/star/beans/PropertyValue.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetConditionalEntries -/** the conditions of a conditional format are managed.@see com::sun::star::sheet::TableConditionalFormat + +#ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__ +#define __com_sun_star_sheet_XSheetConditionalEntries_idl__ + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +#ifndef __com_sun_star_beans_PropertyValue_idl__ +#include <com/sun/star/beans/PropertyValue.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to add and remove conditions of a conditional format. + + @see com::sun::star::sheet::TableConditionalFormat + @see com::sun::star::sheet::TableConditionalEntry */ interface XSheetConditionalEntries: com::sun::star::container::XIndexAccess -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetConditionalEntries::addNew - /** adds a conditional entry to the format.@see com::sun::star::sheet::TableConditionalFormat +{ + //------------------------------------------------------------------------- + + /** adds a conditional entry to the format. + + <p>Supported properties are:</p> + + <dl> + <dt><type>ConditionOperator</type> Operator</dt> + <dd>contains the operation to perform for this condition.</dd> + + <dt><atom>string</atom> Formula1</dt> + <dd>contains the value or formula for the operation.</dd> + + <dt><atom>string</atom> Formula2</dt> + <dd>contains the second value or formula for the operation (used with + <const>ConditionOperator::BETWEEN</const> or + <const>ConditionOperator::NOT_BERWEEN</const> operations).</dd> + + <dt><type scope="com::sun::star::table">CellAddress</type> + SourcePosition</dt> + <dd>contains the base address for relative cell references in formulas. + </dd> + </dl> + + @see com::sun::star::sheet::TableConditionalFormat */ - void addNew( [in] sequence<com::sun::star::beans::PropertyValue> aConditionalEntry ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetConditionalEntries::removeByIndex + void addNew( [in] sequence< com::sun::star::beans::PropertyValue > aConditionalEntry ); + + //------------------------------------------------------------------------- + /** removes a conditional entry from the format. */ - void removeByIndex( [in] long nIndex ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetConditionalEntries::clear - /** clears the format. + void removeByIndex( [in] long nIndex ); + + //------------------------------------------------------------------------- + + /** clears all condition entries. */ - void clear(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/16 16:41:38 jsc - remove interfaceheader with uik and remove [const] in method definitions - - 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.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void clear(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetConditionalEntry.idl b/offapi/com/sun/star/sheet/XSheetConditionalEntry.idl index 3c03cf4cb..137f0d14c 100644 --- a/offapi/com/sun/star/sheet/XSheetConditionalEntry.idl +++ b/offapi/com/sun/star/sheet/XSheetConditionalEntry.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetConditionalEntry.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:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,75 +58,46 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetConditionalEntry_idl__ -#define __com_sun_star_sheet_XSheetConditionalEntry_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetConditionalEntry -/** represents an entry in a conditional format.@see com::sun::star::sheet::TableConditionalEntry + +#ifndef __com_sun_star_sheet_XSheetConditionalEntry_idl__ +#define __com_sun_star_sheet_XSheetConditionalEntry_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to access the cell style name for a condition in a + conditional format. + + @see com::sun::star::sheet::TableConditionalEntry */ interface XSheetConditionalEntry: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetConditionalEntry::getStyleName - - // DocMerge from xml: method com::sun::star::sheet::XSheetConditionalEntry::getStyleName - /** returns the name of the cell style that is used when - the condition is fulfilled. +{ + //------------------------------------------------------------------------- + + /** returns the name of the cell style that is used when the condition + is fulfilled. */ - string getStyleName(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetConditionalEntry::setStyleName - /** sets the name of the cell style that is used when - the condition is fulfilled. + string getStyleName(); + + //------------------------------------------------------------------------- + + /** sets the name of the cell style that is used when the condition + is fulfilled. */ - void setStyleName( [in] string aStyleName ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - 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 + void setStyleName( [in] string aStyleName ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetFilterDescriptor.idl b/offapi/com/sun/star/sheet/XSheetFilterDescriptor.idl index fa9dabd13..15b2e2f47 100644 --- a/offapi/com/sun/star/sheet/XSheetFilterDescriptor.idl +++ b/offapi/com/sun/star/sheet/XSheetFilterDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetFilterDescriptor.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:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,77 +58,48 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__ -#define __com_sun_star_sheet_XSheetFilterDescriptor_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_TableFilterField_idl__ -#include <com/sun/star/sheet/TableFilterField.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetFilterDescriptor -/** represents a description of how to filter cells.@see com::sun::star::sheet::SheetFilterDescriptor + +#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__ +#define __com_sun_star_sheet_XSheetFilterDescriptor_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_TableFilterField_idl__ +#include <com/sun/star/sheet/TableFilterField.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to a collection of filter conditions (filter fields). + + @see com::sun::star::sheet::SheetFilterDescriptor */ interface XSheetFilterDescriptor: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetFilterDescriptor::getFilterFields - - // DocMerge from idl: method com::sun::star::sheet::XSheetFilterDescriptor::getFilterFields - /** returns the definitions of the filter fields. +{ + //------------------------------------------------------------------------- + + /** returns the collection of filter fields. */ - sequence<com::sun::star::sheet::TableFilterField> getFilterFields(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetFilterDescriptor::setFilterFields - /** sets the definitions of the filter fields. + sequence< com::sun::star::sheet::TableFilterField > getFilterFields(); + + //------------------------------------------------------------------------- + + /** sets a new collection of filter fields. */ - void setFilterFields( [in] sequence<com::sun::star::sheet::TableFilterField> aFilterFields ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - 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 + void setFilterFields( + [in] sequence< com::sun::star::sheet::TableFilterField > aFilterFields ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetFilterable.idl b/offapi/com/sun/star/sheet/XSheetFilterable.idl index c59d31a21..5c28510e7 100644 --- a/offapi/com/sun/star/sheet/XSheetFilterable.idl +++ b/offapi/com/sun/star/sheet/XSheetFilterable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetFilterable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,65 +58,58 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetFilterable_idl__ -#define __com_sun_star_sheet_XSheetFilterable_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__ -#include <com/sun/star/sheet/XSheetFilterDescriptor.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetFilterable -/** represents something that can be filtered - using an XSheetFilterDesriptor. + +#ifndef __com_sun_star_sheet_XSheetFilterable_idl__ +#define __com_sun_star_sheet_XSheetFilterable_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__ +#include <com/sun/star/sheet/XSheetFilterDescriptor.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents something that can be filtered using an XSheetFilterDesriptor. + + @see com::sun::star::sheet::XSheetFilterableEx */ interface XSheetFilterable: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetFilterable::createFilterDescriptor +{ + //------------------------------------------------------------------------- + /** creates a filter descriptor. + + @param bEmpty + if set to <TRUE/>, creates an empty filter descriptor. If set to + <FALSE/>, fills the filter descriptor with previous settings of + the current object (i.e. a database range). */ - com::sun::star::sheet::XSheetFilterDescriptor createFilterDescriptor( [in] boolean bEmpty ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetFilterable::filter - /** filters cells out. + com::sun::star::sheet::XSheetFilterDescriptor + createFilterDescriptor( [in] boolean bEmpty ); + + //------------------------------------------------------------------------- + + /** performa a filter operation, using the settings of the passed filter + descriptor. + + @param xDescriptor + the settings for the filter operation. */ - void filter( [in] com::sun::star::sheet::XSheetFilterDescriptor xDescriptor ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void filter( + [in] com::sun::star::sheet::XSheetFilterDescriptor xDescriptor ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetFilterableEx.idl b/offapi/com/sun/star/sheet/XSheetFilterableEx.idl index 84015416d..03ebb064f 100644 --- a/offapi/com/sun/star/sheet/XSheetFilterableEx.idl +++ b/offapi/com/sun/star/sheet/XSheetFilterableEx.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetFilterableEx.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,59 +58,48 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetFilterableEx_idl__ -#define __com_sun_star_sheet_XSheetFilterableEx_idl__ - -#ifndef __com_sun_star_sheet_XSheetFilterable_idl__ -#include <com/sun/star/sheet/XSheetFilterable.idl> -#endif - -#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__ -#include <com/sun/star/sheet/XSheetFilterDescriptor.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetFilterableEx -/** represents something from which criteria for filtering - can be read. +#ifndef __com_sun_star_sheet_XSheetFilterableEx_idl__ +#define __com_sun_star_sheet_XSheetFilterableEx_idl__ + +#ifndef __com_sun_star_sheet_XSheetFilterable_idl__ +#include <com/sun/star/sheet/XSheetFilterable.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__ +#include <com/sun/star/sheet/XSheetFilterDescriptor.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents something from which criteria for filtering can be read. + + <p>In general the current object will be used only to create the + descriptor to filter another object, i.e. the advanced filter feature + in a spreadsheet.</p> + + @see com::sun::star::sheet::SheetCellRange */ interface XSheetFilterableEx: com::sun::star::sheet::XSheetFilterable -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetFilterableEx::createFilterDescriptorByObject - /** creates a filter descriptor for the specified - filterable object from the contents of this object. +{ + //------------------------------------------------------------------------- + + /** creates a filter descriptor for the specified filterable object from + the contents of this object. */ - com::sun::star::sheet::XSheetFilterDescriptor createFilterDescriptorByObject( [in] com::sun::star::sheet::XSheetFilterable xObject ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::sheet::XSheetFilterDescriptor + createFilterDescriptorByObject( + [in] com::sun::star::sheet::XSheetFilterable xObject ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetLinkable.idl b/offapi/com/sun/star/sheet/XSheetLinkable.idl index a46be2a89..98b4654ee 100644 --- a/offapi/com/sun/star/sheet/XSheetLinkable.idl +++ b/offapi/com/sun/star/sheet/XSheetLinkable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetLinkable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,149 +58,111 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetLinkable_idl__ -#define __com_sun_star_sheet_XSheetLinkable_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_SheetLinkMode_idl__ -#include <com/sun/star/sheet/SheetLinkMode.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetLinkable + +#ifndef __com_sun_star_sheet_XSheetLinkable_idl__ +#define __com_sun_star_sheet_XSheetLinkable_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_SheetLinkMode_idl__ +#include <com/sun/star/sheet/SheetLinkMode.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** enables a sheet to refer to another sheet in a different document. - - - - - - - - - - - - - + + <p>To insert a sheet link, the sheet used as linked sheet has to exist + already. The method <member>XSheetLinkable::link</member> creates a + <type>SheetLink</type> object in the document's <type>SheetLinks</type> + collection and links the sheet to the specified external sheet.</p> + + @see com::sun::star::sheet::SheetLinks + @see com::sun::star::sheet::SheetLink + @deprecated */ interface XSheetLinkable: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetLinkable::getLinkMode - /** enables the linking of the sheet and controls - if formulas are copied. - - - - <p>If this is <const>SheetLinkMode::NORMAL</const>, formulas - are copied. With <const>SheetLinkMode::VALUE</const>, only - results of formulas are used.</p> +{ + //------------------------------------------------------------------------- + + /** returns the link mode of the spreadsheet. + + <p>If the returned value is <const>SheetLinkMode::NORMAL</const>, + formulas are copied. With <const>SheetLinkMode::VALUE</const>, + only results of formulas are used.</p> */ - com::sun::star::sheet::SheetLinkMode getLinkMode(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetLinkable::setLinkMode - /** enables the linking of the sheet and controls - if formulas are copied. - - - - <p>If this is <const>SheetLinkMode::NORMAL</const>, formulas - are copied. With <const>SheetLinkMode::VALUE</const>, only - results of formulas are used.</p> + com::sun::star::sheet::SheetLinkMode getLinkMode(); + + //------------------------------------------------------------------------- + + /** enables the linking of the sheet and controls whether formulas + are copied. + + @param nLinkMode + the value specifying the link mode for this spreadsheet. + + <p>If the value is <const>SheetLinkMode::NORMAL</const>, + formulas are copied. With <const>SheetLinkMode::VALUE</const>, + only results of formulas are used.</p> */ - void setLinkMode( [in] com::sun::star::sheet::SheetLinkMode nLinkMode ); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetLinkable::getLinkUrl - - // DocMerge from xml: method com::sun::star::sheet::XSheetLinkable::getLinkUrl + void setLinkMode( [in] com::sun::star::sheet::SheetLinkMode nLinkMode ); + + //------------------------------------------------------------------------- + /** returns the target URL of the link. */ - string getLinkUrl(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetLinkable::setLinkUrl + string getLinkUrl(); + + //------------------------------------------------------------------------- + /** sets the target URL of the link. - - - - <p>A Sheet Link with the same file name must exist - or the link will not work.</p> + + <p>A <type>SheetLink</type> object with the same file name must + exist already or the link will not work.</p> */ - void setLinkUrl( [in] string aLinkUrl ); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetLinkable::getLinkSheetName - - // DocMerge from xml: method com::sun::star::sheet::XSheetLinkable::getLinkSheetName - /** returns the sheet in the source URL. + void setLinkUrl( [in] string aLinkUrl ); + + //------------------------------------------------------------------------- + + /** returns the sheet name of the sheet in the source document. */ - string getLinkSheetName(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetLinkable::setLinkSheetName - /** sets the sheet in the source URL. + string getLinkSheetName(); + + //------------------------------------------------------------------------- + + /** sets the name of the linked sheet in the source document. + + <p>This method sets the sheet name in the <type>SheetLink</type> + object, it does not modify the sheet name in the source document.</p> */ - void setLinkSheetName( [in] string aLinkSheetName ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetLinkable::link + void setLinkSheetName( [in] string aLinkSheetName ); + + //------------------------------------------------------------------------- + /** links the sheet to another sheet in another document. - - - - <p>A sheet link is created if it does not exist, and the - LinkMode, LinkFileName and LinkSheetName attributes are set.</p> + + <p>A <type>SheetLink</type> object is created if it does not exist, + and the link mode, the URL of the linked document and the linked + sheet name are set.</p> */ - void link( [in] string aUrl, - [in] string aSheetName, - [in] string aFilterName, - [in] string aFilterOptions, - [in] com::sun::star::sheet::SheetLinkMode nMode ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - 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 + void link( [in] string aUrl, + [in] string aSheetName, + [in] string aFilterName, + [in] string aFilterOptions, + [in] com::sun::star::sheet::SheetLinkMode nMode ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetOperation.idl b/offapi/com/sun/star/sheet/XSheetOperation.idl index 4923dd01c..db2a22de2 100644 --- a/offapi/com/sun/star/sheet/XSheetOperation.idl +++ b/offapi/com/sun/star/sheet/XSheetOperation.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetOperation.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:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,76 +58,64 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetOperation_idl__ -#define __com_sun_star_sheet_XSheetOperation_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_GeneralFunction_idl__ -#include <com/sun/star/sheet/GeneralFunction.idl> -#endif - -#ifndef __com_sun_star_uno_Exception_idl__ -#include <com/sun/star/uno/Exception.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetOperation -/** represents operations on a cell range or ranges.@see com::sun::star::sheet::SheetCellRanges + +#ifndef __com_sun_star_sheet_XSheetOperation_idl__ +#define __com_sun_star_sheet_XSheetOperation_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_GeneralFunction_idl__ +#include <com/sun/star/sheet/GeneralFunction.idl> +#endif + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to execute operations on a cell range or ranges. + + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SheetCellRanges */ interface XSheetOperation: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetOperation::computeFunction - /** computes a general function of all cells in - the ranges. +{ + //------------------------------------------------------------------------- + + /** computes a general function based on all cells in the current + cell range(s). + + @param nFunction + is the function used to compute the result. + + @returns + the result of the calculation. */ - double computeFunction( [in] com::sun::star::sheet::GeneralFunction nFunction ) - raises( com::sun::star::uno::Exception ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetOperation::clearContents - /** clears selected contents of the range. + double computeFunction( + [in] com::sun::star::sheet::GeneralFunction nFunction ) + raises( com::sun::star::uno::Exception ); //! unnecessary + + //------------------------------------------------------------------------- + + /** clears the specified contents of the current cell range(s). + + @param nContentFlags + a combination of <type>CellFlags</type> flags selecting the + contents to be deleted. */ - void clearContents( [in] long nContentFlags ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void clearContents( [in] long nContentFlags ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/sheet/XSheetOutline.idl b/offapi/com/sun/star/sheet/XSheetOutline.idl index 28c640bf1..08320c9cd 100644 --- a/offapi/com/sun/star/sheet/XSheetOutline.idl +++ b/offapi/com/sun/star/sheet/XSheetOutline.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetOutline.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,114 +58,118 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetOutline_idl__ -#define __com_sun_star_sheet_XSheetOutline_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_table_CellRangeAddress_idl__ -#include <com/sun/star/table/CellRangeAddress.idl> -#endif - -#ifndef __com_sun_star_table_TableOrientation_idl__ -#include <com/sun/star/table/TableOrientation.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetOutline -/** represents outlining functions of a sheet. + +#ifndef __com_sun_star_sheet_XSheetOutline_idl__ +#define __com_sun_star_sheet_XSheetOutline_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_table_CellRangeAddress_idl__ +#include <com/sun/star/table/CellRangeAddress.idl> +#endif + +#ifndef __com_sun_star_table_TableOrientation_idl__ +#include <com/sun/star/table/TableOrientation.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to access the outlines of a sheet. */ interface XSheetOutline: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::group +{ + //------------------------------------------------------------------------- + /** creates an outline group. + + @param aRange + contains the range of rows or columns, depending on + the parameter nOrientation. + + @param nOrientation + the orientation of the new outline (columns or rows). */ - void group( [in] com::sun::star::table::CellRangeAddress aRange, - [in] com::sun::star::table::TableOrientation nOrientation ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::ungroup + void group( + [in] com::sun::star::table::CellRangeAddress aRange, + [in] com::sun::star::table::TableOrientation nOrientation ); + + //------------------------------------------------------------------------- + /** removes outline groups. - - - - <p>In the specified range, all outline groups on the innermost level - are removed.</p> + + <p>In the specified range, all outline groups on the innermost + level are removed.</p> + + @param aRange + contains the range of rows or columns, depending on + the parameter nOrientation. + + @param nOrientation + the orientation of the outlines to remove (columns or rows). */ - void ungroup( [in] com::sun::star::table::CellRangeAddress aRange, - [in] com::sun::star::table::TableOrientation nOrientation ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::autoOutline + void ungroup( + [in] com::sun::star::table::CellRangeAddress aRange, + [in] com::sun::star::table::TableOrientation nOrientation ); + + //------------------------------------------------------------------------- + /** creates outline groups from formula references in a range. + + @param aRange + the cell range for which outlines are generated. */ - void autoOutline( [in] com::sun::star::table::CellRangeAddress aRange ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::clearOutline - /** removes all outline groups on the sheet. + void autoOutline( [in] com::sun::star::table::CellRangeAddress aRange ); + + //------------------------------------------------------------------------- + + /** removes all outline groups from the sheet. */ - void clearOutline(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::hideDetail - /** hides an outline group. + void clearOutline(); + + //------------------------------------------------------------------------- + + /** collapses an outline group. + + @param aRange + the cell range for which the outlines are collapsed. */ - void hideDetail( [in] com::sun::star::table::CellRangeAddress aRange ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::showDetail - /** shows an outline group. + void hideDetail( [in] com::sun::star::table::CellRangeAddress aRange ); + + //------------------------------------------------------------------------- + + /** reopens an outline group. + + @param aRange + the cell range for which the outlines are reopened. */ - void showDetail( [in] com::sun::star::table::CellRangeAddress aRange ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::showLevel - /** shows all outlined groups below a specified level. + void showDetail( [in] com::sun::star::table::CellRangeAddress aRange ); + + //------------------------------------------------------------------------- + + /** shows all outlined groups below a specific level. + + @param nLevel + all outline levels from 1 to this value will be opened and + the higher levels will be closed. + + @param nOrientation + the orientation of the outlines (columns or rows). */ - void showLevel( [in] short nLevel, - [in] com::sun::star::table::TableOrientation nOrientation ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.4 2000/09/11 11:52:52 mi - documentation merged from XML - - 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 + void showLevel( + [in] short nLevel, + [in] com::sun::star::table::TableOrientation nOrientation ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetPageBreak.idl b/offapi/com/sun/star/sheet/XSheetPageBreak.idl index 2fc8644b2..6ebb405e0 100644 --- a/offapi/com/sun/star/sheet/XSheetPageBreak.idl +++ b/offapi/com/sun/star/sheet/XSheetPageBreak.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetPageBreak.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,105 +58,71 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetPageBreak_idl__ -#define __com_sun_star_sheet_XSheetPageBreak_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_TablePageBreakData_idl__ -#include <com/sun/star/sheet/TablePageBreakData.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetPageBreak + +#ifndef __com_sun_star_sheet_XSheetPageBreak_idl__ +#define __com_sun_star_sheet_XSheetPageBreak_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_TablePageBreakData_idl__ +#include <com/sun/star/sheet/TablePageBreakData.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** provides access to page breaks in a sheet. - - - - - - - - - - - - - + @deprecated */ interface XSheetPageBreak: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetPageBreak::getColumnPageBreaks - - // DocMerge from idl: method com::sun::star::sheet::XSheetPageBreak::getColumnPageBreaks - /** returns a sequence of descriptions of all horizontal - page breaks on the sheet. - - <P>This includes manual and automatic page breaks. - To add or remove manual breaks, use the - <member scope="com::sun::star::table">TableColumn::IsStartOfNewPage</member> - property of the column.</P> +{ + //------------------------------------------------------------------------- + + /** returns a sequence of descriptions of all horizontal page breaks + on the sheet. + + <P>This includes manual and automatic page breaks. To add or + remove manual breaks, use the + <member scope="com::sun::star::table">TableColumn::IsStartOfNewPage</member> + property of the column.</P> + + @returns + a sequence of structs containing column page break data. */ - sequence<com::sun::star::sheet::TablePageBreakData> getColumnPageBreaks(); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetPageBreak::getRowPageBreaks - - // DocMerge from idl: method com::sun::star::sheet::XSheetPageBreak::getRowPageBreaks - /** returns a sequence of descriptions of all vertical - page breaks on the sheet. - - <P>This includes manual and automatic page breaks.</P> - To add or remove manual breaks, use the - <member scope="com::sun::star::table">TableRow::IsStartOfNewPage</member> - property of the row.</P> + sequence< com::sun::star::sheet::TablePageBreakData > getColumnPageBreaks(); + + //------------------------------------------------------------------------- + + /** returns a sequence of descriptions of all vertical page breaks + on the sheet. + + <P>This includes manual and automatic page breaks. To add or + remove manual breaks, use the + <member scope="com::sun::star::table">TableRow::IsStartOfNewPage</member> + property of the row.</P> + + @returns + a sequence of structs containing row page break data. */ - sequence<com::sun::star::sheet::TablePageBreakData> getRowPageBreaks(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetPageBreak::removeAllManualPageBreaks + sequence< com::sun::star::sheet::TablePageBreakData > getRowPageBreaks(); + + //------------------------------------------------------------------------- + /** removes all manual page breaks on the sheet. */ - void removeAllManualPageBreaks(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - 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 + void removeAllManualPageBreaks(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSheetPastable.idl b/offapi/com/sun/star/sheet/XSheetPastable.idl index c2b3cc2f9..d1623162b 100644 --- a/offapi/com/sun/star/sheet/XSheetPastable.idl +++ b/offapi/com/sun/star/sheet/XSheetPastable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetPastable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,112 +58,77 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSheetPastable_idl__ -#define __com_sun_star_sheet_XSheetPastable_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_table_CellAddress_idl__ -#include <com/sun/star/table/CellAddress.idl> -#endif - -#ifndef __com_sun_star_table_CellRangeAddress_idl__ -#include <com/sun/star/table/CellRangeAddress.idl> -#endif - -#ifndef __com_sun_star_sheet_PasteOperation_idl__ -#include <com/sun/star/sheet/PasteOperation.idl> -#endif - -#ifndef __com_sun_star_sheet_CellInsertMode_idl__ -#include <com/sun/star/sheet/CellInsertMode.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSheetPastable -/** represents a sheet into which contents of the clipboard - can be pasted. - - - - - - - - - - - - - + +#ifndef __com_sun_star_sheet_XSheetPastable_idl__ +#define __com_sun_star_sheet_XSheetPastable_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +#ifndef __com_sun_star_table_CellRangeAddress_idl__ +#include <com/sun/star/table/CellRangeAddress.idl> +#endif + +#ifndef __com_sun_star_sheet_PasteOperation_idl__ +#include <com/sun/star/sheet/PasteOperation.idl> +#endif + +#ifndef __com_sun_star_sheet_CellInsertMode_idl__ +#include <com/sun/star/sheet/CellInsertMode.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a sheet into which contents of the clipboard can be pasted. + @deprecated */ interface XSheetPastable: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetPastable::paste - /** pastes the contents of the clipboard at the specified +{ + //------------------------------------------------------------------------- + + /** pastes the contents of the clipboard at the specified position on the sheet. */ - void paste( [in] com::sun::star::table::CellAddress aDestination ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetPastable::pasteFormat - /** pastes the contents of the clipboard at the + void paste( [in] com::sun::star::table::CellAddress aDestination ); + + //------------------------------------------------------------------------- + + /** pastes the contents of the clipboard at the specified position on the sheet, using the specified format. */ - void pasteFormat( [in] com::sun::star::table::CellAddress aDestination, - [in] string aFormat ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSheetPastable::pasteCellRange - /** pastes clipboard data from a cell range into + void pasteFormat( [in] com::sun::star::table::CellAddress aDestination, + [in] string aFormat ); + + //------------------------------------------------------------------------- + + /** pastes clipboard data from a cell range into another cell range. - - - + <p>The contents of the clipboard must be from a cell range.</p> */ - void pasteCellRange( [in] com::sun::star::table::CellRangeAddress aDestination, - [in] com::sun::star::sheet::PasteOperation nOperation, - [in] short nContents, - [in] boolean bSkipEmpty, - [in] boolean bTranspose, - [in] boolean bAsLink, - [in] com::sun::star::sheet::CellInsertMode nInsert ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void pasteCellRange( [in] com::sun::star::table::CellRangeAddress aDestination, + [in] com::sun::star::sheet::PasteOperation nOperation, + [in] short nContents, + [in] boolean bSkipEmpty, + [in] boolean bTranspose, + [in] boolean bAsLink, + [in] com::sun::star::sheet::CellInsertMode nInsert ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSpreadsheet.idl b/offapi/com/sun/star/sheet/XSpreadsheet.idl index 1b65a82da..8325dec52 100644 --- a/offapi/com/sun/star/sheet/XSpreadsheet.idl +++ b/offapi/com/sun/star/sheet/XSpreadsheet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSpreadsheet.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:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,66 +58,53 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSpreadsheet_idl__ -#define __com_sun_star_sheet_XSpreadsheet_idl__ - -#ifndef __com_sun_star_sheet_XSheetCellRange_idl__ -#include <com/sun/star/sheet/XSheetCellRange.idl> -#endif - -//============================================================================= - - module com { module sun { module star { module sheet { - -interface XSheetCellCursor; - -//============================================================================= - -// DocMerge: empty anyway -interface XSpreadsheet: XSheetCellRange -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheet::createCursor - /** creates a cell cursor.@see com::sun::star::sheet::Spreadsheet + +#ifndef __com_sun_star_sheet_XSpreadsheet_idl__ +#define __com_sun_star_sheet_XSpreadsheet_idl__ + +#ifndef __com_sun_star_sheet_XSheetCellRange_idl__ +#include <com/sun/star/sheet/XSheetCellRange.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +interface XSheetCellCursor; + +//============================================================================= + +/** provides methods to create a cell range cursor. + */ +interface XSpreadsheet: com::sun::star::sheet::XSheetCellRange +{ + //------------------------------------------------------------------------- + + /** creates a cell cursor including the whole spreadsheet. + + @see com::sun::star::sheet::SheetCellCursor */ - XSheetCellCursor createCursor(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheet::createCursorByRange - /** creates a cell cursor to travel in - the given range context.@see com::sun::star::sheet::Spreadsheet + com::sun::star::sheet::XSheetCellCursor createCursor(); + + //------------------------------------------------------------------------- + + /** creates a cell cursor to travel in the given range context. + + @param aRange + the cell range for the cursor. + + @see com::sun::star::sheet::SheetCellCursor */ - XSheetCellCursor createCursorByRange( [in] XSheetCellRange aRange ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::sheet::XSheetCellCursor createCursorByRange( + [in] com::sun::star::sheet::XSheetCellRange aRange ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSpreadsheetDocument.idl b/offapi/com/sun/star/sheet/XSpreadsheetDocument.idl index 57d5eec9c..44cb5c136 100644 --- a/offapi/com/sun/star/sheet/XSpreadsheetDocument.idl +++ b/offapi/com/sun/star/sheet/XSpreadsheetDocument.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSpreadsheetDocument.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:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,63 +58,43 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSpreadsheetDocument_idl__ -#define __com_sun_star_sheet_XSpreadsheetDocument_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_XSpreadsheets_idl__ -#include <com/sun/star/sheet/XSpreadsheets.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSpreadsheetDocument -/** a container of spreadsheets.@see com::sun::star::sheet::SpreadsheetDocument + +#ifndef __com_sun_star_sheet_XSpreadsheetDocument_idl__ +#define __com_sun_star_sheet_XSpreadsheetDocument_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_XSpreadsheets_idl__ +#include <com/sun/star/sheet/XSpreadsheets.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to a collection of spreadsheets. + + @see com::sun::star::sheet::SpreadsheetDocument */ interface XSpreadsheetDocument: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheetDocument::getSheets - /** returns the container of sheets in the document.@see Spreadsheets +{ + //------------------------------------------------------------------------- + + /** returns the collection of sheets in the document. + + @see com::sun::star::sheet::Spreadsheets */ - com::sun::star::sheet::XSpreadsheets getSheets(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::sheet::XSpreadsheets getSheets(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSpreadsheetView.idl b/offapi/com/sun/star/sheet/XSpreadsheetView.idl index 112fceedf..fae6d07c7 100644 --- a/offapi/com/sun/star/sheet/XSpreadsheetView.idl +++ b/offapi/com/sun/star/sheet/XSpreadsheetView.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSpreadsheetView.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,22 +76,19 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSpreadsheetView -/** the main interface of a <type>SpreadsheetView</type>. It +/** is the main interface of a <type>SpreadsheetView</type>. It manages the active sheet within this view. */ interface XSpreadsheetView: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheetView::getActiveSheet /** returns the sheet that is shown in the view. */ com::sun::star::sheet::XSpreadsheet getActiveSheet(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheetView::setActiveSheet /** sets the sheet that is shown in the view. */ void setActiveSheet( [in] com::sun::star::sheet::XSpreadsheet xActiveSheet ); @@ -102,21 +99,5 @@ interface XSpreadsheetView: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +#endif + diff --git a/offapi/com/sun/star/sheet/XSpreadsheets.idl b/offapi/com/sun/star/sheet/XSpreadsheets.idl index 0280bbdb2..85d018545 100644 --- a/offapi/com/sun/star/sheet/XSpreadsheets.idl +++ b/offapi/com/sun/star/sheet/XSpreadsheets.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSpreadsheets.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,77 +58,70 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSpreadsheets_idl__ -#define __com_sun_star_sheet_XSpreadsheets_idl__ - -#ifndef __com_sun_star_container_XNameContainer_idl__ -#include <com/sun/star/container/XNameContainer.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSpreadsheets -/** represents the collection of sheets in a document.@see com::sun::star::sheet::Spreadsheets + +#ifndef __com_sun_star_sheet_XSpreadsheets_idl__ +#define __com_sun_star_sheet_XSpreadsheets_idl__ + +#ifndef __com_sun_star_container_XNameContainer_idl__ +#include <com/sun/star/container/XNameContainer.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to access the spreadsheets by name and to insert, + copy, remove and rearrange spreadsheets. + + @see com::sun::star::sheet::Spreadsheets */ interface XSpreadsheets: com::sun::star::container::XNameContainer -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheets::insertNewByName +{ + //------------------------------------------------------------------------- + /** inserts a new sheet into the collection. + + @param aName + the name of the new spreadsheet. + @param nPosition + the index of the new spreadsheet in the collection. */ - void insertNewByName( [in] string aName, - [in] short nPosition ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheets::moveByName + void insertNewByName( [in] string aName, [in] short nPosition ); + + //------------------------------------------------------------------------- + /** moves a sheet within the collection. + + @param aName + the name of the spreadsheet to move. + @param nDestination + the new index of the spreadsheet in the collection. */ - void moveByName( [in] string aName, - [in] short nDestination ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheets::copyByName + void moveByName( [in] string aName, [in] short nDestination ); + + //------------------------------------------------------------------------- + /** copies a sheet within the collection. + + @param aName + the name of the spreadsheet to copy. + @param aCopy + the name of the copy of the spreadsheet. + @param nDestination + the index of the copy in the collection. */ - void copyByName( [in] string aName, - [in] string aCopy, - [in] short nDestination ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void copyByName( + [in] string aName, + [in] string aCopy, + [in] short nDestination ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSubTotalCalculatable.idl b/offapi/com/sun/star/sheet/XSubTotalCalculatable.idl index 8c0c6b896..0c3a9d0c9 100644 --- a/offapi/com/sun/star/sheet/XSubTotalCalculatable.idl +++ b/offapi/com/sun/star/sheet/XSubTotalCalculatable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSubTotalCalculatable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,73 +58,72 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSubTotalCalculatable_idl__ -#define __com_sun_star_sheet_XSubTotalCalculatable_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__ -#include <com/sun/star/sheet/XSubTotalDescriptor.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSubTotalCalculatable -/** The interface contains methods to handle a SubTotaldescriptor. - The SubTotaldescriptor provides properties to set up the SubTotal function. + +#ifndef __com_sun_star_sheet_XSubTotalCalculatable_idl__ +#define __com_sun_star_sheet_XSubTotalCalculatable_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__ +#include <com/sun/star/sheet/XSubTotalDescriptor.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** contains methods to handle a subtotal descriptor. + + <p>The subtotal descriptor provides properties to set up the subtotal + function.</p> + + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SubTotalDescriptor */ interface XSubTotalCalculatable: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSubTotalCalculatable::createSubTotalDescriptor +{ + //------------------------------------------------------------------------- + /** creates a subtotal descriptor. + + @param bEmpty + if set to <TRUE/>, creates an empty descriptor. If set to + <FALSE/>, fills the descriptor with previous settings of the + current object (i.e. a database range). */ - com::sun::star::sheet::XSubTotalDescriptor createSubTotalDescriptor( [in] boolean bEmpty ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSubTotalCalculatable::applySubTotals - /** creates subtotals. + com::sun::star::sheet::XSubTotalDescriptor createSubTotalDescriptor( + [in] boolean bEmpty ); + + //------------------------------------------------------------------------- + + /** creates subtotals using the settings of the passed descriptor. + + @param xDescriptor + the subtotal descriptor with the settings used for the subtotal + operation. + + @param bReplace + if set to <TRUE/>, replaces previous subtotal results. */ - void applySubTotals( [in] com::sun::star::sheet::XSubTotalDescriptor xDescriptor, - [in] boolean bReplace ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSubTotalCalculatable::removeSubTotals - /** removes the subtotals. + void applySubTotals( + [in] com::sun::star::sheet::XSubTotalDescriptor xDescriptor, + [in] boolean bReplace ); + + //------------------------------------------------------------------------- + + /** removes the subtotals from the current object. */ - void removeSubTotals(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void removeSubTotals(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSubTotalDescriptor.idl b/offapi/com/sun/star/sheet/XSubTotalDescriptor.idl index 0644b80aa..77cc77dd2 100644 --- a/offapi/com/sun/star/sheet/XSubTotalDescriptor.idl +++ b/offapi/com/sun/star/sheet/XSubTotalDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSubTotalDescriptor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,72 +58,57 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__ -#define __com_sun_star_sheet_XSubTotalDescriptor_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_SubTotalColumn_idl__ -#include <com/sun/star/sheet/SubTotalColumn.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSubTotalDescriptor -/** represents a description of how subtotals are - to be inserted.@see com::sun::star::sheet::SubTotalDescriptor + +#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__ +#define __com_sun_star_sheet_XSubTotalDescriptor_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_SubTotalColumn_idl__ +#include <com/sun/star/sheet/SubTotalColumn.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to the collection of subtotal fields in a subtotal + descriptor. + + @see com::sun::star::sheet::SubTotalDescriptor */ interface XSubTotalDescriptor: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSubTotalDescriptor::addNew +{ + //------------------------------------------------------------------------- + /** adds a subtotal field definition to the descriptor. + + @param aSubTotalColumns + a sequence of all columns used to calculate subtotal values. + + @param nGroupColumn + specifies which column of the source range is used to group the + contents of the source data. */ - void addNew( [in] sequence<com::sun::star::sheet::SubTotalColumn> aSubTotalColumns, - [in] long nGroupColumn ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSubTotalDescriptor::clear + void addNew( + [in] sequence< com::sun::star::sheet::SubTotalColumn > aSubTotalColumns, + [in] long nGroupColumn ); + + //------------------------------------------------------------------------- + /** removes all subtotal field definitions from the descriptor. */ - void clear(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void clear(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XSubTotalField.idl b/offapi/com/sun/star/sheet/XSubTotalField.idl index 66634cff1..43a4b2158 100644 --- a/offapi/com/sun/star/sheet/XSubTotalField.idl +++ b/offapi/com/sun/star/sheet/XSubTotalField.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSubTotalField.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,93 +58,64 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XSubTotalField_idl__ -#define __com_sun_star_sheet_XSubTotalField_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_SubTotalColumn_idl__ -#include <com/sun/star/sheet/SubTotalColumn.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XSubTotalField -/** represents a field in a subtotal descriptor.@see com::sun::star::sheet::SubTotalField + +#ifndef __com_sun_star_sheet_XSubTotalField_idl__ +#define __com_sun_star_sheet_XSubTotalField_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_SubTotalColumn_idl__ +#include <com/sun/star/sheet/SubTotalColumn.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to the settings of a field in a subtotal descriptor. + + @see com::sun::star::sheet::SubTotalField + @see com::sun::star::sheet::SubTotalDescriptor */ interface XSubTotalField: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSubTotalField::getGroupColumn +{ + //------------------------------------------------------------------------- + /** returns the column by which entries are grouped. */ - long getGroupColumn(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSubTotalField::setGroupColumn + long getGroupColumn(); + + //------------------------------------------------------------------------- + /** sets the column by which entries are grouped. */ - void setGroupColumn( [in] long nGroupColumn ); - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSubTotalField::getSubTotalColumns - - // DocMerge from idl: method com::sun::star::sheet::XSubTotalField::getSubTotalColumns - /** returns the definitions of which columns should have - subtotals added to them. + void setGroupColumn( [in] long nGroupColumn ); + + //------------------------------------------------------------------------- + + /** returns the definitions of which columns should have subtotals + added to them. */ - sequence<com::sun::star::sheet::SubTotalColumn> getSubTotalColumns(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XSubTotalField::setSubTotalColumns - /** sets the definitions of which columns should have - subtotals added to them. + sequence< com::sun::star::sheet::SubTotalColumn > getSubTotalColumns(); + + //------------------------------------------------------------------------- + + /** sets the definitions of which columns should have subtotals + added to them. */ - void setSubTotalColumns( [in] sequence<com::sun::star::sheet::SubTotalColumn> aSubTotalColumns ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:52 hjs - initial import - - Revision 1.5 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - 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 + void setSubTotalColumns( + [in] sequence< com::sun::star::sheet::SubTotalColumn > + aSubTotalColumns ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl b/offapi/com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl index a8c6e567d..ae0b72ff8 100644 --- a/offapi/com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl +++ b/offapi/com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUniqueCellFormatRangesSupplier.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: sab $ $Date: 2001-07-06 11:47:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XUniqueCellFormatRangesSupplier_idl__ #define __com_sun_star_sheet_XUniqueCellFormatRangesSupplier_idl__ @@ -71,17 +72,33 @@ //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -/** provides a collection of cell formats. +/** provides access to a collection of collections of equal-formatted + cell ranges. + + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SheetCellRanges */ interface XUniqueCellFormatRangesSupplier: com::sun::star::uno::XInterface { - /** returns the collection of cell formats. - <p>Every different cell format is represented by a - <type scope="com::sun::star::sheet">SheetCellRanges</type> object.</p> + /** returns a collection of equal-formatted cell range collections. + + <p>Each cell of the original range is contained in one of the + ranges (even unformatted cells). If there is a non-rectangular + equal-formatted cell area, it will be split into several + rectangular ranges.</p> + + <p>All equal-formatted ranges are consolidated into one collection. + These collections are the members contained in a + <type>UniqueCellFormatRanges</type> collection.</p> + + @returns + the collection of equal-formatted cell range collections. + + @see com::sun::star::sheet::UniqueCellFormatRanges */ com::sun::star::container::XIndexAccess getUniqueCellFormatRanges(); }; @@ -91,3 +108,4 @@ interface XUniqueCellFormatRangesSupplier: com::sun::star::uno::XInterface }; }; }; }; #endif + diff --git a/offapi/com/sun/star/sheet/XUsedAreaCursor.idl b/offapi/com/sun/star/sheet/XUsedAreaCursor.idl index 8a71b6ba8..9e7f92389 100644 --- a/offapi/com/sun/star/sheet/XUsedAreaCursor.idl +++ b/offapi/com/sun/star/sheet/XUsedAreaCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUsedAreaCursor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,67 +58,55 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XUsedAreaCursor_idl__ -#define __com_sun_star_sheet_XUsedAreaCursor_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XUsedAreaCursor -/** represents a cursor which can move to the start - or end of the used area of a sheet.@see com::sun::star::sheet::SheetCellCursor + +#ifndef __com_sun_star_sheet_XUsedAreaCursor_idl__ +#define __com_sun_star_sheet_XUsedAreaCursor_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to find the used area of the entire sheet. + + <p>The used area is the smallest cell range that contains all cells + of the spreadsheet with any contents (values, text, formulas) or + visible formatting (borders and background color).</p> + + @see com::sun::star::sheet::SheetCellCursor */ interface XUsedAreaCursor: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XUsedAreaCursor::gotoStartOfUsedArea +{ + //------------------------------------------------------------------------- + /** points the cursor to the start of the used area. + + @param bExpand + <TRUE/> = expands the current cursor range, + <FALSE/> = sets size of the cursor to a single cell. */ - void gotoStartOfUsedArea( [in] boolean bExpand ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XUsedAreaCursor::gotoEndOfUsedArea + void gotoStartOfUsedArea( [in] boolean bExpand ); + + //------------------------------------------------------------------------- + /** points the cursor to the end of the used area. + + @param bExpand + <TRUE/> = expands the current cursor range, + <FALSE/> = sets size of the cursor to a single cell. */ - void gotoEndOfUsedArea( [in] boolean bExpand ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $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:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + void gotoEndOfUsedArea( [in] boolean bExpand ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XViewFreezable.idl b/offapi/com/sun/star/sheet/XViewFreezable.idl index 4eb310c15..00bd6bfc0 100644 --- a/offapi/com/sun/star/sheet/XViewFreezable.idl +++ b/offapi/com/sun/star/sheet/XViewFreezable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XViewFreezable.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,6 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XViewFreezable /** enables a <type>SpreadsheetView</type> to freeze columns and rows of the view. */ @@ -80,11 +79,8 @@ interface XViewFreezable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewFreezable::hasFrozenPanes /** returns <TRUE/> if the view has frozen panes. - - - + <p>Only one of <member>XViewSplitable::getIsWindowSplit()</member> and <member>XViewFreezable::hasFrozenPanes()</member> @@ -94,12 +90,9 @@ interface XViewFreezable: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewFreezable::freezeAtPosition /** freezes panes with the specified number of columns and rows. - - - + <p>To freeze only horizontally, specify nRows as 0. To freeze only vertically, specify nColumns as 0.</p> */ @@ -112,24 +105,5 @@ interface XViewFreezable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:40 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +#endif + diff --git a/offapi/com/sun/star/sheet/XViewPane.idl b/offapi/com/sun/star/sheet/XViewPane.idl index bb1a6aaf7..41559bfad 100644 --- a/offapi/com/sun/star/sheet/XViewPane.idl +++ b/offapi/com/sun/star/sheet/XViewPane.idl @@ -2,9 +2,9 @@ * * $RCSfile: XViewPane.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,42 +76,38 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XViewPane -/** represents a pane in a view of a spreadsheet document.@see com::sun::star::sheet::SpreadsheetViewPane +/** represents a pane in a view of a spreadsheet document. + + @see com::sun::star::sheet::SpreadsheetViewPane */ interface XViewPane: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewPane::getFirstVisibleColumn /** returns the first column that is visible in the pane. */ long getFirstVisibleColumn(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewPane::setFirstVisibleColumn /** sets the first column that is visible in the pane. */ void setFirstVisibleColumn( [in] long nFirstVisibleColumn ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewPane::getFirstVisibleRow /** returns the first row that is visible in the pane. */ long getFirstVisibleRow(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewPane::setFirstVisibleRow /** sets the first row that is visible in the pane. */ void setFirstVisibleRow( [in] long nFirstVisibleRow ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewPane::getVisibleRange /** returns the address of the cell range that consists of the cells which are visible in the pane. */ @@ -123,27 +119,5 @@ interface XViewPane: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $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:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +#endif + diff --git a/offapi/com/sun/star/sheet/XViewPanesSupplier.idl b/offapi/com/sun/star/sheet/XViewPanesSupplier.idl index 801368a62..e9dfa1182 100644 --- a/offapi/com/sun/star/sheet/XViewPanesSupplier.idl +++ b/offapi/com/sun/star/sheet/XViewPanesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XViewPanesSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,57 +58,41 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XViewPanesSupplier_idl__ -#define __com_sun_star_sheet_XViewPanesSupplier_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XViewPanesSupplier + +#ifndef __com_sun_star_sheet_XViewPanesSupplier_idl__ +#define __com_sun_star_sheet_XViewPanesSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + /** enables access to the panes in a view. + + @deprecated */ interface XViewPanesSupplier: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XViewPanesSupplier::getViewPanes +{ + //------------------------------------------------------------------------- + /** returns the collection of panes in the view. */ - com::sun::star::container::XIndexAccess getViewPanes(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::container::XIndexAccess getViewPanes(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/XViewSplitable.idl b/offapi/com/sun/star/sheet/XViewSplitable.idl index 2e8d88f4f..e947bfa27 100644 --- a/offapi/com/sun/star/sheet/XViewSplitable.idl +++ b/offapi/com/sun/star/sheet/XViewSplitable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XViewSplitable.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,33 +72,17 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XViewSplitable /** enables a <type>SpreadsheetView</type> to split the view. - - - - - - - - - - - - - + @deprecated */ interface XViewSplitable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewSplitable::getIsWindowSplit /** returns <TRUE/> if the view is split into individual panes. - - <p>Only one of <member>XViewSplitable::getIsWindowSplit()</member> and <member>XViewFreezable::hasFrozenPanes()</member> @@ -108,7 +92,6 @@ interface XViewSplitable: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewSplitable::getSplitHorizontal /** returns the horizontal position in pixels where the view is split. */ @@ -116,7 +99,6 @@ interface XViewSplitable: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewSplitable::getSplitVertical /** returns the vertical position in pixels where the view is split. */ @@ -124,25 +106,20 @@ interface XViewSplitable: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewSplitable::getSplitColumn /** returns the column before which the view is split. */ long getSplitColumn(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewSplitable::getSplitRow /** returns the row before which the view is split. */ long getSplitRow(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewSplitable::splitAtPosition /** splits the view at the specified position. - - <p>To split only horizontally, specify <var>nPixelY</var> as 0. To split only vertically, specify <var>nPixelX</var> as 0.</p> */ @@ -155,24 +132,5 @@ interface XViewSplitable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:40 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif +#endif + diff --git a/offapi/com/sun/star/sheet/XVolatileResult.idl b/offapi/com/sun/star/sheet/XVolatileResult.idl index e251addc2..0295617a8 100644 --- a/offapi/com/sun/star/sheet/XVolatileResult.idl +++ b/offapi/com/sun/star/sheet/XVolatileResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: XVolatileResult.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,64 +58,50 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet_XVolatileResult_idl__ -#define __com_sun_star_sheet_XVolatileResult_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_sheet_XResultListener_idl__ -#include <com/sun/star/sheet/XResultListener.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::sheet::XVolatileResult -/** represents a volatile function result. + +#ifndef __com_sun_star_sheet_XVolatileResult_idl__ +#define __com_sun_star_sheet_XVolatileResult_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_sheet_XResultListener_idl__ +#include <com/sun/star/sheet/XResultListener.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides methods to handle a volatile function result. + + @see com::sun::star::sheet::VolatileResult + @see com::sun::star::sheet::ResultEvent */ interface XVolatileResult: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XVolatileResult::addResultListener +{ + //------------------------------------------------------------------------- + /** adds a listener to be notified when a new value is available. */ - [oneway] void addResultListener( [in] com::sun::star::sheet::XResultListener aListener ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::sheet::XVolatileResult::removeResultListener + [oneway] void addResultListener( + [in] com::sun::star::sheet::XResultListener aListener ); + + //------------------------------------------------------------------------- + /** removes the specified listener. */ - [oneway] void removeResultListener( [in] com::sun::star::sheet::XResultListener aListener ); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ -#endif + [oneway] void removeResultListener( + [in] com::sun::star::sheet::XResultListener aListener ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/_NamedRange.idl b/offapi/com/sun/star/sheet/_NamedRange.idl index 3dd547125..5b0fb3675 100644 --- a/offapi/com/sun/star/sheet/_NamedRange.idl +++ b/offapi/com/sun/star/sheet/_NamedRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: _NamedRange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,77 +58,50 @@ * * ************************************************************************/ -#ifndef __com_sun_star_sheet__NamedRange_idl__ -#define __com_sun_star_sheet__NamedRange_idl__ - - -//============================================================================= - - module com { module sun { module star { module sheet { - -//============================================================================= - -// DocMerge from idl: constants com::sun::star::sheet::_NamedRange + +#ifndef __com_sun_star_sheet__NamedRange_idl__ +#define __com_sun_star_sheet__NamedRange_idl__ + +//============================================================================= + + module com { module sun { module star { module sheet { + +//============================================================================= + /** @deprecated + @see com::sun::star::sheet::NamedRangeFlag */ constants _NamedRange -{ - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::1 - - // DocMerge from idl: value com::sun::star::sheet::_NamedRange::FILTER_CRITERIA +{ + //------------------------------------------------------------------------- + /** The range contains filter criteria. */ - const long FILTER_CRITERIA = 1; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::2 - - // DocMerge from idl: value com::sun::star::sheet::_NamedRange::PRINT_AREA + const long FILTER_CRITERIA = 1; + + //------------------------------------------------------------------------- + /** The range can be used as a print range. */ - const long PRINT_AREA = 2; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::4 - - // DocMerge from idl: value com::sun::star::sheet::_NamedRange::COLUMN_HEADER + const long PRINT_AREA = 2; + + //------------------------------------------------------------------------- + /** The range can be used as column headers for printing. */ - const long COLUMN_HEADER = 4; - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::8 - - // DocMerge from idl: value com::sun::star::sheet::_NamedRange::ROW_HEADER + const long COLUMN_HEADER = 4; + + //------------------------------------------------------------------------- + /** The range can be used as row headers for printing. */ - const long ROW_HEADER = 8; - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.5 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - 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 + const long ROW_HEADER = 8; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + |