diff options
author | Michael Hönnig <mi@openoffice.org> | 2002-10-03 12:11:20 +0000 |
---|---|---|
committer | Michael Hönnig <mi@openoffice.org> | 2002-10-03 12:11:20 +0000 |
commit | cb23f6a62077022736a40d6315ee92a218f489e0 (patch) | |
tree | 713895d0de4930fd1a37b2fb7bb6ded971a2acdf /offapi/com/sun/star/table | |
parent | 625aff4ec7a47d618a9da160e962fc6fb5c834c5 (diff) |
#94968# IDL reviews merged
Diffstat (limited to 'offapi/com/sun/star/table')
35 files changed, 979 insertions, 1155 deletions
diff --git a/offapi/com/sun/star/table/BorderLine.idl b/offapi/com/sun/star/table/BorderLine.idl index 54e9815221c5..ef8fa5eb1078 100644 --- a/offapi/com/sun/star/table/BorderLine.idl +++ b/offapi/com/sun/star/table/BorderLine.idl @@ -2,9 +2,9 @@ * * $RCSfile: BorderLine.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,52 +58,47 @@ * * ************************************************************************/ + #ifndef __com_sun_star_table_BorderLine_idl__ #define __com_sun_star_table_BorderLine_idl__ - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: struct com::sun::star::table::BorderLine /** describes the line type for a single cell edge. */ struct BorderLine { - // DocMerge from xml: field com::sun::star::table::BorderLine::Color - /** color of the line. + //------------------------------------------------------------------------- + + /** contains the color value of the line. */ long Color; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::BorderLine::InnerLineWidth - /** width of the inner part of a double line. - + /** contains the width of the inner part of a double line (in 1/100 mm). - <p>If this is zero, only a single line is drawn.</p> + <p>If this value is zero, only a single line is drawn.</p> */ short InnerLineWidth; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::BorderLine::OuterLineWidth - /** width of a single line or width of - outer part of a double line. - + /** contaions the width of a single line or the width of outer part of + a double line (in 1/100 mm). - <p>If this is zero, no line is drawn.</p> + <p>If this value is zero, no line is drawn.</p> */ short OuterLineWidth; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::BorderLine::LineDistance - /** distance between the inner and outer parts - of a double line. + /** contains the distance between the inner and outer parts of a + double line (in 1/100 mm). */ short LineDistance; @@ -113,18 +108,5 @@ struct BorderLine }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/Cell.idl b/offapi/com/sun/star/table/Cell.idl index 19cb819031b2..c1f163f38bb1 100644 --- a/offapi/com/sun/star/table/Cell.idl +++ b/offapi/com/sun/star/table/Cell.idl @@ -2,9 +2,9 @@ * * $RCSfile: Cell.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:35 $ * * 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_table_Cell_idl__ #define __com_sun_star_table_Cell_idl__ @@ -73,25 +74,32 @@ #include <com/sun/star/text/XText.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: service com::sun::star::table::Cell -/** range of 1 row and 1 column. +/** represents a singe cell within a table. */ service Cell { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** contains the properties of the table cell. + */ service com::sun::star::table::CellProperties; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the cell contents. + */ interface com::sun::star::table::XCell; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to formatted and unformatted text contents. + */ interface com::sun::star::text::XText; }; @@ -100,18 +108,5 @@ service Cell }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/CellAddress.idl b/offapi/com/sun/star/table/CellAddress.idl index f5fed146b95d..1f9b7ecc1a5e 100644 --- a/offapi/com/sun/star/table/CellAddress.idl +++ b/offapi/com/sun/star/table/CellAddress.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellAddress.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,38 +58,35 @@ * * ************************************************************************/ + #ifndef __com_sun_star_table_CellAddress_idl__ #define __com_sun_star_table_CellAddress_idl__ - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: struct com::sun::star::table::CellAddress -/** used to identify a cell within a - spreadsheet document. +/** contains a cell address within a spreadsheet document. */ struct CellAddress { - // DocMerge from xml: field com::sun::star::table::CellAddress::Sheet - /** index of the sheet that contains the cell. + //------------------------------------------------------------------------- + + /** is the index of the sheet that contains the cell. */ short Sheet; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::CellAddress::Column - /** index of the column where the cell is located. + /** is the index of the column where the cell is located. */ long Column; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::CellAddress::Row - /** index of the row where the cell is located. + /** is the index of the row where the cell is located. */ long Row; @@ -99,18 +96,5 @@ struct CellAddress }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/CellContentType.idl b/offapi/com/sun/star/table/CellContentType.idl index bcfcf254fece..65e303e0699a 100644 --- a/offapi/com/sun/star/table/CellContentType.idl +++ b/offapi/com/sun/star/table/CellContentType.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellContentType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:35 $ * * 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_table_CellContentType_idl__ #define __com_sun_star_table_CellContentType_idl__ - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: enum com::sun::star::table::CellContentType -/** enumeration used to determine the type of contents in - a cell. +/** is used to determine the type of contents in a cell. */ enum CellContentType { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellContentType::EMPTY /** cell is empty. */ EMPTY, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellContentType::VALUE /** cell contains a constant value. */ VALUE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellContentType::TEXT /** cell contains text. */ TEXT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellContentType::FORMULA /** cell contains a formula. */ FORMULA @@ -108,18 +102,5 @@ enum CellContentType }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/CellCursor.idl b/offapi/com/sun/star/table/CellCursor.idl index ba62671a25c2..f095ad24dbe7 100644 --- a/offapi/com/sun/star/table/CellCursor.idl +++ b/offapi/com/sun/star/table/CellCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellCursor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:36 $ * * 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_table_CellCursor_idl__ #define __com_sun_star_table_CellCursor_idl__ @@ -65,19 +66,23 @@ #include <com/sun/star/table/XCellCursor.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: service com::sun::star::table::CellCursor -/** cursor in a table. +/** represents a cell cursor in a table. + + <p>A cell cursor is simply a cell range which provides methods to move + through the table (i.e. relative to the current position).</p> */ service CellCursor { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to control the position of the cursor. + */ interface com::sun::star::table::XCellCursor; }; @@ -86,18 +91,5 @@ service CellCursor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/CellHoriJustify.idl b/offapi/com/sun/star/table/CellHoriJustify.idl index 0a0b19260e9f..70cd88d94bea 100644 --- a/offapi/com/sun/star/table/CellHoriJustify.idl +++ b/offapi/com/sun/star/table/CellHoriJustify.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellHoriJustify.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,60 +58,52 @@ * * ************************************************************************/ + #ifndef __com_sun_star_table_CellHoriJustify_idl__ #define __com_sun_star_table_CellHoriJustify_idl__ - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: enum com::sun::star::table::CellHoriJustify -/** enumeration used to specify how cell contents are - aligned horizontally. +/** specifies how cell contents are aligned horizontally. */ enum CellHoriJustify { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellHoriJustify::STANDARD /** default alignment is used (left for numbers, right for text). */ STANDARD, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellHoriJustify::LEFT - /** contents are aligned with the left edge of the cell. + /** contents are aligned to the left edge of the cell. */ LEFT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellHoriJustify::CENTER /** contents are horizontally centered. */ CENTER, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellHoriJustify::RIGHT /** contents are aligned to the right edge of the cell. */ RIGHT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellHoriJustify::BLOCK - /** contents are justified in the cell. + /** contents are justified to the cell width. */ BLOCK, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellHoriJustify::REPEAT /** contents are repeated to fill the cell. */ REPEAT @@ -122,18 +114,5 @@ enum CellHoriJustify }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/CellOrientation.idl b/offapi/com/sun/star/table/CellOrientation.idl index 3110c63240ae..d72100abd0b8 100644 --- a/offapi/com/sun/star/table/CellOrientation.idl +++ b/offapi/com/sun/star/table/CellOrientation.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellOrientation.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,45 +58,40 @@ * * ************************************************************************/ + #ifndef __com_sun_star_table_CellOrientation_idl__ #define __com_sun_star_table_CellOrientation_idl__ - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: enum com::sun::star::table::CellOrientation -/** enumeration used to specify the orientation of a cell. +/** specifies the orientation of a cell. */ enum CellOrientation { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellOrientation::STANDARD /** contents are printed from left to right. */ STANDARD, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellOrientation::TOPBOTTOM /** contents are printed from top to bottom. */ TOPBOTTOM, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellOrientation::BOTTOMTOP /** contents are printed from bottom to top. */ BOTTOMTOP, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellOrientation::STACKED /** contents are printed from top to bottom with individual characters in normal (horizontal) orientation. */ @@ -108,18 +103,5 @@ enum CellOrientation }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/CellProperties.idl b/offapi/com/sun/star/table/CellProperties.idl index 700f9a4dd91f..9d796219ca35 100644 --- a/offapi/com/sun/star/table/CellProperties.idl +++ b/offapi/com/sun/star/table/CellProperties.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellProperties.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: nn $ $Date: 2002-04-08 14:34:00 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:37 $ * * 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_table_CellProperties_idl__ #define __com_sun_star_table_CellProperties_idl__ @@ -89,90 +90,100 @@ #include <com/sun/star/table/TableBorder.idl> #endif +#ifndef __com_sun_star_table_BorderLine_idl__ +#include <com/sun/star/table/BorderLine.idl> +#endif + +#ifndef __com_sun_star_container_XNameContainer_idl__ +#include <com/sun/star/container/XNameContainer.idl> +#endif //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: service com::sun::star::table::CellProperties -/** service that holds all cell properties.@see Cell +/** contains the properties of a table cell. + + @see com::sun::star::table::Cell + @see com::sun::star::table::CellRange */ service CellProperties { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- + //========================================================================= - // DocMerge from xml: property com::sun::star::table::CellProperties::CellStyle /** contains the name of the style of the cell. */ - [property] string CellStyle; + [optional, property] string CellStyle; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::CellProperties::CellBackColor /** contains the cell background color. */ [property] long CellBackColor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::CellProperties::IsCellBackgroundTransparent - /** If this property is <TRUE/>, the cell background is transparent, - and the <member>CellProperties::CellBackColor</member> value is not used. + /** is <TRUE/>, if the cell background is transparent. + + <p>In this case the <member>CellProperties::CellBackColor</member> + value is not used.</p> */ [property] boolean IsCellBackgroundTransparent; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::CellProperties::NumberFormat - /** contains the index of the number format - that is used in the cells. - - <p>The proper value can be determined by using the - <type scope="com::sun::star::util">NumberFormatter</type> - interface of the document.</p> + /** contains the horizontal alignment of the cell contents. */ - [property] long NumberFormat; + [property] com::sun::star::table::CellHoriJustify HoriJustify; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::CellProperties::ShadowFormat - /** contains a description of the shadow. + /** contains the vertical alignment of the cell contents. */ - [property] com::sun::star::table::ShadowFormat ShadowFormat; + [property] com::sun::star::table::CellVertJustify VertJustify; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::CellProperties::HoriJustify - /** property containing the horizontal alignment of - text within the cells. + /** is <TRUE/>, if text in the cells will be wrapped automatically + at the right border. */ - [property] com::sun::star::table::CellHoriJustify HoriJustify; + [property] boolean IsTextWrapped; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::CellProperties::VertJustify - /** property containing the vertical alignment of - text within the cells. + /** defines the indentation of the cell contents (in 1/100 mm). */ - [property] com::sun::star::table::CellVertJustify VertJustify; + [property] short ParaIndent; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::CellProperties::Orientation - /** property containing the orientation of text - within the cells. + /** contains the orientation of the cell contents. + <p>If the <member>CellProperties::RotateAngle</member> property + is non-zero, this value is not used.</p> + */ + [property] com::sun::star::table::CellOrientation Orientation; + //------------------------------------------------------------------------- - <p>If the <member>CellProperties::RotateAngle</member> property is non-zero, - this value is not used.</p> + /** defines how much the content of cells is rotated (in 1/100 degrees). */ - [property] com::sun::star::table::CellOrientation Orientation; + [property] long RotateAngle; + + //------------------------------------------------------------------------- + + /** defines at which edge rotated cells are aligned. + */ + [property] com::sun::star::table::CellVertJustify RotateReference; //------------------------------------------------------------------------- @@ -189,91 +200,78 @@ service CellProperties //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::CellProperties::CellProtection - /** contains a description of the cell - protection. - + /** contains a description of the cell or cell range border. - - <p>Cell protection is active only if the sheet is - protected.</p> + <p>If used with a cell range, the top, left, right, and bottom + lines are at the edges of the entire range, not at the edges of + the individual cell.</p> */ - [property] com::sun::star::util::CellProtection CellProtection; + [property] com::sun::star::table::TableBorder TableBorder; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::CellProperties::TableBorder - /** property containing a description of the cell border. - - - - <p>If used with a cell range, the top, left, right, - and bottom lines are at the edges of the entire range, - not at the edges of the individual cell.</p> + /** contains a description of the top border line of each cell. */ - [property] com::sun::star::table::TableBorder TableBorder; + [property] com::sun::star::table::BorderLine TopBorder; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::CellProperties::IsTextWrapped - /** property is <TRUE/> if text in the cells is wrapped. - */ - [property] boolean IsTextWrapped; + /** contains a description of the bottom border line of each cell. + */ + [property] com::sun::star::table::BorderLine BottomBorder; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::CellProperties::RotateAngle - /** defines how much the content of cells - is rotated (1/100th degrees). + /** contains a description of the left border line of each cell. */ - [property] long RotateAngle; + [property] com::sun::star::table::BorderLine LeftBorder; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::CellProperties::RotateReference - /** defines at which edge rotated cells are aligned. + /** contains a description of the right border line of each cell. */ - [property] com::sun::star::table::CellVertJustify RotateReference; - -}; + [property] com::sun::star::table::BorderLine RightBorder; -//============================================================================= + //------------------------------------------------------------------------- -}; }; }; }; + /** contains the index of the number format that is used in the cells. -/*============================================================================= + <p>The proper value can be determined by using the + <type scope="com::sun::star::util">NumberFormatter</type> + interface of the document.</p> + */ + [property] long NumberFormat; - $Log: not supported by cvs2svn $ - Revision 1.6 2001/10/25 15:57:04 mi - proofreading and corrections from Richard Holt + //------------------------------------------------------------------------- - Revision 1.5 2000/12/21 08:35:19 mi - @see interface/service/... ident -> @see ident - for new docu generator + /** contains a description of the shadow. + */ + [property] com::sun::star::table::ShadowFormat ShadowFormat; - Revision 1.4 2000/12/14 12:53:43 mi - <true></true> -> <TRUE/> and same with FALSE + //------------------------------------------------------------------------- - Revision 1.3 2000/11/08 12:44:18 mi - moved from api + /** contains a description of the cell protection. - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import + <p>Cell protection is active only if the sheet is protected.</p> + */ + [property] com::sun::star::util::CellProtection CellProtection; - Revision 1.6 2000/09/11 11:52:57 mi - documentation merged from XML + //------------------------------------------------------------------------- - Revision 1.4 2000/08/02 10:28:59 mi - CharacterProperties and ParagraphProperties now in sheet/SheetCell... + /** stores additional attributes. - Revision 1.3 2000/06/16 10:34:12 mi - #76027# CharacterProperties only at SheetCell now + <p>This property is used i.e. by the XML filters to load and + restore unknown attributes.</p> + */ + [optional, property] com::sun::star::container::XNameContainer + UserDefinedAttributes; - Revision 1.2 2000/02/09 15:07:01 mi - #72869# get/setCellStyle moved to CellProperties + //------------------------------------------------------------------------- +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/table/CellRange.idl b/offapi/com/sun/star/table/CellRange.idl index 67412325fa3e..bc2bed3d2046 100644 --- a/offapi/com/sun/star/table/CellRange.idl +++ b/offapi/com/sun/star/table/CellRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellRange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:37 $ * * 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_table_CellRange_idl__ #define __com_sun_star_table_CellRange_idl__ @@ -69,26 +70,26 @@ #include <com/sun/star/table/XCellRange.idl> #endif -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: service com::sun::star::table::CellRange -/** area of cells within a spreadsheet (table). +/** represents a range of of cells within a table. */ service CellRange { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** contains the properties of the cells of this cell range. + */ service com::sun::star::table::CellProperties; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the cells or to sub-ranges of this cell range. + */ interface com::sun::star::table::XCellRange; }; @@ -97,21 +98,5 @@ service CellRange }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.4 2000/09/11 11:52:57 mi - documentation merged from XML - - Revision 1.2 2000/02/17 11:08:22 mi - #73104# CellRange has no XNamed - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/table/CellRangeAddress.idl b/offapi/com/sun/star/table/CellRangeAddress.idl index c436202a76d4..9b919f46496d 100644 --- a/offapi/com/sun/star/table/CellRangeAddress.idl +++ b/offapi/com/sun/star/table/CellRangeAddress.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellRangeAddress.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:57:04 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,57 +58,47 @@ * * ************************************************************************/ + #ifndef __com_sun_star_table_CellRangeAddress_idl__ #define __com_sun_star_table_CellRangeAddress_idl__ - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: struct com::sun::star::table::CellRangeAddress -/** used to identify a cell range within a - spreadsheet document. +/** contains a cell range address within a spreadsheet document. */ struct CellRangeAddress { - // DocMerge from xml: field com::sun::star::table::CellRangeAddress::Sheet - /** index of the sheet that contains the - cell range. + //------------------------------------------------------------------------- + + /** is the index of the sheet that contains the cell range. */ short Sheet; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::CellRangeAddress::StartColumn - /** index of the column where the left edge - of the range is located. + /** is the index of the column of the left edge of the range. */ long StartColumn; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::CellRangeAddress::StartRow - /** index of the row where the top edge - of the range is located. + /** is the index of the row of the top edge of the range. */ long StartRow; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::CellRangeAddress::EndColumn - /** index of the column where the right - edge of the range is located. + /** is the index of the column of the right edge of the range. */ long EndColumn; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::CellRangeAddress::EndRow - /** index of the row where the bottom edge - of the range is located. + /** is the index of the row of the bottom edge of the range. */ long EndRow; @@ -118,21 +108,5 @@ struct CellRangeAddress }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:18 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/CellVertJustify.idl b/offapi/com/sun/star/table/CellVertJustify.idl index a09c8ab9fb75..092deddd5569 100644 --- a/offapi/com/sun/star/table/CellVertJustify.idl +++ b/offapi/com/sun/star/table/CellVertJustify.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellVertJustify.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:38 $ * * 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_table_CellVertJustify_idl__ #define __com_sun_star_table_CellVertJustify_idl__ - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: enum com::sun::star::table::CellVertJustify -/** enumeration used to specify how cell contents are aligned - vertically. +/** specifies how cell contents are aligned vertically. */ enum CellVertJustify { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellVertJustify::STANDARD /** default alignment is used. */ STANDARD, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellVertJustify::TOP /** contents are aligned with the upper edge of the cell. */ TOP, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellVertJustify::CENTER /** contents are aligned to the vertical middle of the cell. */ CENTER, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::CellVertJustify::BOTTOM /** contents are aligned to the lower edge of the cell. */ BOTTOM @@ -108,18 +102,5 @@ enum CellVertJustify }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/ShadowFormat.idl b/offapi/com/sun/star/table/ShadowFormat.idl index c4e898962d35..e02973b09515 100644 --- a/offapi/com/sun/star/table/ShadowFormat.idl +++ b/offapi/com/sun/star/table/ShadowFormat.idl @@ -2,9 +2,9 @@ * * $RCSfile: ShadowFormat.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:38 $ * * 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_table_ShadowFormat_idl__ #define __com_sun_star_table_ShadowFormat_idl__ @@ -65,41 +66,37 @@ #include <com/sun/star/table/ShadowLocation.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: struct com::sun::star::table::ShadowFormat -/** describes a shadow. +/** describes the settings of a cell shadow. */ struct ShadowFormat { - // DocMerge from xml: field com::sun::star::table::ShadowFormat::Location - /** location of the shadow. + //------------------------------------------------------------------------- + + /** contains the location of the shadow. */ com::sun::star::table::ShadowLocation Location; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::ShadowFormat::ShadowWidth - /** size of the shadow. + /** contains the size of the shadow. */ short ShadowWidth; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::ShadowFormat::IsTransparent - /** shadow is transparent if this is <TRUE/>. + /** is <TRUE/>, if shadow is transparent. */ boolean IsTransparent; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::ShadowFormat::Color - /** color of the shadow. + /** contains the color value of the shadow. */ long Color; @@ -109,21 +106,5 @@ struct ShadowFormat }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:18 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/ShadowLocation.idl b/offapi/com/sun/star/table/ShadowLocation.idl index 2f112d29c9ff..a57a7031c3cf 100644 --- a/offapi/com/sun/star/table/ShadowLocation.idl +++ b/offapi/com/sun/star/table/ShadowLocation.idl @@ -2,9 +2,9 @@ * * $RCSfile: ShadowLocation.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,53 +58,46 @@ * * ************************************************************************/ + #ifndef __com_sun_star_table_ShadowLocation_idl__ #define __com_sun_star_table_ShadowLocation_idl__ - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: enum com::sun::star::table::ShadowLocation -/** enumeration used to specify the location of the shadow - in a <type>ShadowFormat</type>. +/** specifies the location of the shadow in a <type>ShadowFormat</type>. */ enum ShadowLocation { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::ShadowLocation::NONE /** no shadow. */ NONE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::ShadowLocation::TOP_LEFT /** shadow is located along the upper and left sides. */ TOP_LEFT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::ShadowLocation::TOP_RIGHT /** shadow is located along the upper and right sides. */ TOP_RIGHT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::ShadowLocation::BOTTOM_LEFT /** shadow is located along the lower and left sides. */ BOTTOM_LEFT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::ShadowLocation::BOTTOM_RIGHT /** shadow is located along the lower and right sides. */ BOTTOM_RIGHT @@ -115,18 +108,5 @@ enum ShadowLocation }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/TableBorder.idl b/offapi/com/sun/star/table/TableBorder.idl index dc61266e58fd..353a3299d70c 100644 --- a/offapi/com/sun/star/table/TableBorder.idl +++ b/offapi/com/sun/star/table/TableBorder.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableBorder.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:57:04 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:39 $ * * 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_table_TableBorder_idl__ #define __com_sun_star_table_TableBorder_idl__ @@ -65,119 +66,115 @@ #include <com/sun/star/table/BorderLine.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: struct com::sun::star::table::TableBorder -/** structure contains the values of the border lines of all boxes in a table. - <p> - In a queried structure, the flags in +/** contains the style settings of the border lines of all cells in a cell + range. + + <p>In a queried structure, the flags in <member>TableBorder::Is...LineValid</member> indicate that not all - lines of the boxes have the same values. + lines of the boxes have the same values.</p> - </p> <p>In a structure which is used for setting, these flags determine - if the corresponding line should be set or if the old value should be kept.</p> + if the corresponding line should be set or if the old value should + be kept.</p> */ struct TableBorder { - // DocMerge from xml: field com::sun::star::table::TableBorder::TopLine - /** line at the top edge. + //------------------------------------------------------------------------- + + /** determines the line style at the top edge. */ com::sun::star::table::BorderLine TopLine; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::TableBorder::IsTopLineValid - /** specifies whether the value of <member>TableBorder::TopLine</member> is used. + /** specifies whether the value of <member>TableBorder::TopLine</member> + is used. */ boolean IsTopLineValid; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::TableBorder::BottomLine - /** line at the bottom edge. + /** determines the line style at the bottom edge. */ com::sun::star::table::BorderLine BottomLine; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::TableBorder::IsBottomLineValid - /** specifies whether the value of <member>TableBorder::BottomLine</member> is used. + /** specifies whether the value of + <member>TableBorder::BottomLine</member> is used. */ boolean IsBottomLineValid; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::TableBorder::LeftLine - /** line at the left edge. + /** determines the line style at the left edge. */ com::sun::star::table::BorderLine LeftLine; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::TableBorder::IsLeftLineValid - /** specifies whether the value of <member>TableBorder::LeftLine</member> is used. + /** specifies whether the value of <member>TableBorder::LeftLine</member> + is used. */ boolean IsLeftLineValid; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::TableBorder::RightLine - /** line at the right edge. + /** determines the line style at the right edge. */ com::sun::star::table::BorderLine RightLine; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::TableBorder::IsRightLineValid - /** specifies whether the value of <member>TableBorder::RightLine</member> is used. + /** specifies whether the value of <member>TableBorder::RightLine</member> + is used. */ boolean IsRightLineValid; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::TableBorder::HorizontalLine - /** specifies the horizontal lines for the inner part of a table. + /** determines the line style of horizontal lines for the inner part + of a cell range. */ com::sun::star::table::BorderLine HorizontalLine; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::TableBorder::IsHorizontalLineValid - /** specifies whether the value of <member>TableBorder::HorizontalLine</member> is used. + /** specifies whether the value of + <member>TableBorder::HorizontalLine</member> is used. */ boolean IsHorizontalLineValid; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::TableBorder::VerticalLine - /** vertical lines for the inner part of a table. + /** determines the line style of vertical lines for the inner part + of a cell range. */ com::sun::star::table::BorderLine VerticalLine; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::TableBorder::IsVerticalLineValid - /** specifies whether the value of <member>TableBorder::VerticalLine</member> is used. + /** specifies whether the value of + <member>TableBorder::VerticalLine</member> is used. */ boolean IsVerticalLineValid; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::TableBorder::Distance - /** distance between the lines and other contents. + /** contains the distance between the lines and other contents. */ short Distance; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::table::TableBorder::IsDistanceValid - /** specifies whether the value of <member>TableBorder::Distance</member> is used. + /** specifies whether the value of <member>TableBorder::Distance</member> + is used. */ boolean IsDistanceValid; @@ -187,21 +184,5 @@ struct TableBorder }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/TableChart.idl b/offapi/com/sun/star/table/TableChart.idl index 8ef06d1d1f84..5fef975dfc17 100644 --- a/offapi/com/sun/star/table/TableChart.idl +++ b/offapi/com/sun/star/table/TableChart.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableChart.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:19 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:39 $ * * 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_table_TableChart_idl__ #define __com_sun_star_table_TableChart_idl__ @@ -73,25 +74,37 @@ #include <com/sun/star/container/XNamed.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: service com::sun::star::table::TableChart -/** chart based on the data in a table. +/** represents a chart based on data in a table or spreadsheet. + + <p>This service does not represent the chart document model itself, + but the object in the table that contains this chart document.<p/> */ service TableChart { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the settings of this chart. + */ interface com::sun::star::table::XTableChart; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the chart document model. + + @see com::sun::star::chart::ChartDocument + */ interface com::sun::star::document::XEmbeddedObjectSupplier; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to access the name of the chart. + */ interface com::sun::star::container::XNamed; }; @@ -100,18 +113,5 @@ service TableChart }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/TableCharts.idl b/offapi/com/sun/star/table/TableCharts.idl index 1005a6f1a9ca..d8f41bdb5a00 100644 --- a/offapi/com/sun/star/table/TableCharts.idl +++ b/offapi/com/sun/star/table/TableCharts.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableCharts.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:19 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:39 $ * * 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_table_TableCharts_idl__ #define __com_sun_star_table_TableCharts_idl__ @@ -69,30 +70,41 @@ #include <com/sun/star/container/XIndexAccess.idl> #endif -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: service com::sun::star::table::TableCharts -/** collection of charts based on data in tables. +/** represents a collection of all charts based on data in a table. + + @see com::sun::star::table::TableChart */ service TableCharts { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to insert and remove charts. + */ interface com::sun::star::table::XTableCharts; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to access the charts via index. + */ interface com::sun::star::container::XIndexAccess; - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; + //------------------------------------------------------------------------- + + /** creates an enumeration of all contained charts. + + @see com::sun::star::table::TableChartsEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; }; @@ -100,18 +112,5 @@ service TableCharts }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/TableChartsEnumeration.idl b/offapi/com/sun/star/table/TableChartsEnumeration.idl new file mode 100644 index 000000000000..0c34c4df0b3a --- /dev/null +++ b/offapi/com/sun/star/table/TableChartsEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: TableChartsEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:09:40 $ + * + * 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_table_TableChartsEnumeration_idl__ +#define __com_sun_star_table_TableChartsEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module table { + +//============================================================================= + +/** represents an enumeration of table charts. + + @see com::sun::star::table::TableCharts + */ +service TableChartsEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the charts in the enumeration. + + @see com::sun::star::table::TableChart + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/table/TableColumn.idl b/offapi/com/sun/star/table/TableColumn.idl index cdea30c646c4..f3f882f7c344 100644 --- a/offapi/com/sun/star/table/TableColumn.idl +++ b/offapi/com/sun/star/table/TableColumn.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableColumn.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-03-23 08:59:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:40 $ * * 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_table_TableColumn_idl__ #define __com_sun_star_table_TableColumn_idl__ @@ -73,57 +74,65 @@ #include <com/sun/star/container/XNamed.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: service com::sun::star::table::TableColumn -/** special cell range containing all cells - of a single specific column in a table or spreadsheet. +/** represents a special cell range containing all cells of a single + specific column in a table or spreadsheet. */ service TableColumn { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the cells of this column. + + @see com::sun::star::table::CellRange + */ interface com::sun::star::table::XCellRange; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the cell properties of all cells of this column. + */ interface com::sun::star::beans::XPropertySet; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to access the name of the column. + + <p>In spreadsheets, the name of a column cannot be changed.<p/> + */ interface com::sun::star::container::XNamed; - //------------------------------------------------------------------------- + //========================================================================= - // DocMerge from xml: property com::sun::star::table::TableColumn::Width - /** width of the row. + /** contains the width of the column (in 1/100th mm). - <p>When hidden, it returns the width which the column would have, if - it were visible. </p> + <p>When hidden, it returns the width which the column would have, + if it were visible. </p> */ [property] long Width; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::TableColumn::OptimalWidth - /** If this property is set, the column always keeps its optimal width. + /** is <TRUE/>, if the column always keeps its optimal width. */ [property] boolean OptimalWidth; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::TableColumn::IsVisible - /** This property is <TRUE/> if the column is visible. + /** is <TRUE/>, if the column is visible. */ [property] boolean IsVisible; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::TableColumn::IsStartOfNewPage - /** if there is a manual horizontal - page break attached to the column. + /** is <TRUE/>, if there is a manual horizontal page break attached + to the column. */ [property] boolean IsStartOfNewPage; @@ -133,24 +142,5 @@ service TableColumn }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:43 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/TableColumns.idl b/offapi/com/sun/star/table/TableColumns.idl index d2abcd784bd7..73e35beea20c 100644 --- a/offapi/com/sun/star/table/TableColumns.idl +++ b/offapi/com/sun/star/table/TableColumns.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableColumns.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:42 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:40 $ * * 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_table_TableColumns_idl__ #define __com_sun_star_table_TableColumns_idl__ @@ -65,36 +66,46 @@ #include <com/sun/star/table/XTableColumns.idl> #endif -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> #endif #ifndef __com_sun_star_container_XNameAccess_idl__ #include <com/sun/star/container/XNameAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: service com::sun::star::table::TableColumns -/** collection of all columns of a table or spreadsheet.@see TableColumn +/** represents a collection of all columns of a table or spreadsheet. + + @see com::sun::star::table::TableColumn */ service TableColumns { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to insert and remove columns. + */ interface com::sun::star::table::XTableColumns; - // DocMerge: empty anyway - interface com::sun::star::container::XIndexAccess; + //------------------------------------------------------------------------- + + /** creates an enumeration of all contained columns. + + @see com::sun::star::table::TableColumnsEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + + //------------------------------------------------------------------------- + /** provides methods to access the columns via their names. - // DocMerge from xml: service com::sun::star::table::TableColumns: interface com::sun::star::container::XNameAccess - /** This optional interface is for accessing the columns via - their names. + <p>The names of the columns are always absolute even if the current + cell range is a sub-range of a spreadsheet.</p> */ [optional] interface com::sun::star::container::XNameAccess; @@ -104,21 +115,5 @@ service TableColumns }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/TableColumnsEnumeration.idl b/offapi/com/sun/star/table/TableColumnsEnumeration.idl new file mode 100644 index 000000000000..38926ff08f07 --- /dev/null +++ b/offapi/com/sun/star/table/TableColumnsEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: TableColumnsEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:09:40 $ + * + * 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_table_TableColumnsEnumeration_idl__ +#define __com_sun_star_table_TableColumnsEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module table { + +//============================================================================= + +/** represents an enumeration of table columns. + + @see com::sun::star::table::TableColumns + */ +service TableColumnsEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the columns in the enumeration. + + @see com::sun::star::table::TableColumn + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/table/TableOrientation.idl b/offapi/com/sun/star/table/TableOrientation.idl index 883bb6c7a345..9952a0d755ac 100644 --- a/offapi/com/sun/star/table/TableOrientation.idl +++ b/offapi/com/sun/star/table/TableOrientation.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableOrientation.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:19 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,32 +58,28 @@ * * ************************************************************************/ + #ifndef __com_sun_star_table_TableOrientation_idl__ #define __com_sun_star_table_TableOrientation_idl__ - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: enum com::sun::star::table::TableOrientation -/** enumeration used to select whether operations are - carried out on columns or rows. +/** used to select whether operations are carried out on columns or rows. */ enum TableOrientation { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::TableOrientation::COLUMNS /** operations are carried out on columns. */ COLUMNS, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::table::TableOrientation::ROWS /** operations are carried out on rows. */ ROWS @@ -94,18 +90,5 @@ enum TableOrientation }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 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/table/TableRow.idl b/offapi/com/sun/star/table/TableRow.idl index 3ef0e5e2b826..201e663406fe 100644 --- a/offapi/com/sun/star/table/TableRow.idl +++ b/offapi/com/sun/star/table/TableRow.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableRow.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-03-23 08:59:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09: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_table_TableRow_idl__ #define __com_sun_star_table_TableRow_idl__ @@ -65,62 +66,61 @@ #include <com/sun/star/table/XCellRange.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 table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: service com::sun::star::table::TableRow -/** cell range containing all cells of a - single specific row in a table or spreadsheet. +/** represents a special cell range containing all cells of a single + specific row in a table or spreadsheet. */ service TableRow { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the cells of this row. + + @see com::sun::star::table::CellRange + */ interface com::sun::star::table::XCellRange; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the cell properties of all cells of this row. + */ interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- + //========================================================================= - // DocMerge from xml: property com::sun::star::table::TableRow::Height - /** height of the row. + /** contains the height of the row (in 1/100 mm). - <p>When hidden, it returns the height which the row would have, if - it were visible. </p> + <p>When hidden, it returns the height which the row would have, + if it were visible. </p> */ [property] long Height; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::TableRow::OptimalHeight - /** If this property is set, the row always keeps its optimal height. + /** is <TRUE/>, if the row always keeps its optimal height. */ [property] boolean OptimalHeight; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::TableRow::IsVisible - /** This property is <TRUE/> if the row is visible. + /** is <TRUE/>, if the row is visible. */ [property] boolean IsVisible; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::TableRow::IsStartOfNewPage - /** if there is a manual vertical - page break attached to the row. + /** is <TRUE/>, if there is a manual vertical page break attached + to the row. */ [property] boolean IsStartOfNewPage; @@ -130,27 +130,5 @@ service TableRow }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/02/09 09:27:11 mi - #74964 no XNamed anymore (why ever it was in there again) - - Revision 1.4 2000/12/14 12:53:43 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/table/TableRows.idl b/offapi/com/sun/star/table/TableRows.idl index 0d7c002dbd82..b1f6b1d13c75 100644 --- a/offapi/com/sun/star/table/TableRows.idl +++ b/offapi/com/sun/star/table/TableRows.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableRows.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:19 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09: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_table_TableRows_idl__ #define __com_sun_star_table_TableRows_idl__ @@ -65,27 +66,35 @@ #include <com/sun/star/table/XTableRows.idl> #endif -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: service com::sun::star::table::TableRows -/** collection of all rows of a table or spreadsheet.@see TableRow +/** represents a collection of all rows of a table or spreadsheet. + + @see com::sun::star::table::TableRow */ service TableRows { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to insert and remove rows. + */ interface com::sun::star::table::XTableRows; - // DocMerge: empty anyway - interface com::sun::star::container::XIndexAccess; + //------------------------------------------------------------------------- + + /** creates an enumeration of all contained rows. + + @see com::sun::star::table::TableRowsEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; }; @@ -93,21 +102,5 @@ service TableRows }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:57 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/table/TableRowsEnumeration.idl b/offapi/com/sun/star/table/TableRowsEnumeration.idl new file mode 100644 index 000000000000..0759c528c150 --- /dev/null +++ b/offapi/com/sun/star/table/TableRowsEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: TableRowsEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:09: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_table_TableRowsEnumeration_idl__ +#define __com_sun_star_table_TableRowsEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module table { + +//============================================================================= + +/** represents an enumeration of table rows. + + @see com::sun::star::table::TableRows + */ +service TableRowsEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the rows in the enumeration. + + @see com::sun::star::table::TableRow + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/table/TableSortDescriptor.idl b/offapi/com/sun/star/table/TableSortDescriptor.idl index e2d8267364b7..c21bf53feb3a 100644 --- a/offapi/com/sun/star/table/TableSortDescriptor.idl +++ b/offapi/com/sun/star/table/TableSortDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableSortDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:57:04 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:42 $ * * 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_table_TableSortDescriptor_idl__ #define __com_sun_star_table_TableSortDescriptor_idl__ @@ -73,55 +74,51 @@ #include <com/sun/star/table/TableOrientation.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: service com::sun::star::table::TableSortDescriptor -/** service used to sort rows or columns of tables. - <p> - It extends the general SortDescriptor by table-specific properties. -</p> +/** contains properties which describe sorting of rows or columns in a table. + + <p>It extends the general + <type scope="com::sun::star::util">SortDescriptor</type> with + table-specific properties.</p> */ service TableSortDescriptor { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** contains common sorting properties. + */ service com::sun::star::util::SortDescriptor; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR TableSortDescriptor::SortFields + //========================================================================= - // DocMerge from idl: property com::sun::star::table::TableSortDescriptor::SortFields /** specifies the descriptions of the individual sort fields. */ [property] sequence<com::sun::star::util::SortField> SortFields; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::TableSortDescriptor::MaxFieldCount - /** returns the maximum number of - sort fields the descriptor can hold. + /** contains the maximum number of sort fields the descriptor can hold. */ [readonly, property] long MaxFieldCount; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::TableSortDescriptor::Orientation - /** specifies the orientation for how data is sorted. -<p> - Some implementations do not support sorting columns. -</p> + /** specifies the sorting orientation (sort rows or columns). + + <p>Some implementations may not support sorting columns.</p> */ [property] com::sun::star::table::TableOrientation Orientation; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::table::TableSortDescriptor::ContainsHeader - /** specifies if the first row or column - contains headers which should not be sorted. + /** specifies whether the first row or column (depending on + <member>TableSortDescriptor::Orientation</member>) is a header which + should not be sorted. */ [property] boolean ContainsHeader; @@ -131,27 +128,5 @@ service TableSortDescriptor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:56 hjs - initial import - - Revision 1.5 2000/09/11 11:52:57 mi - documentation merged from XML - - Revision 1.3 2000/03/24 13:19:03 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:58 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/table/XAutoFormattable.idl b/offapi/com/sun/star/table/XAutoFormattable.idl index 034f60104674..a4271ee2d6b7 100644 --- a/offapi/com/sun/star/table/XAutoFormattable.idl +++ b/offapi/com/sun/star/table/XAutoFormattable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAutoFormattable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:42 $ * * 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_table_XAutoFormattable_idl__ #define __com_sun_star_table_XAutoFormattable_idl__ @@ -69,23 +70,25 @@ #include <com/sun/star/lang/IllegalArgumentException.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: interface com::sun::star::table::XAutoFormattable -/** represents a table (or part of a table) - to which AutoFormats can be applied. +/** provides a method to apply TableAutoFormats to a cell range. */ interface XAutoFormattable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XAutoFormattable::autoFormat - /** applies an AutoFormat. + /** applies an AutoFormat to the cell range of the current context. + + @param aName + is the name of the AutoFormat to apply. + + @throws <type scope="com::sun::star::lang">IllegalArgumentException</type> + if the specified AutoFormat does not exist. */ void autoFormat( [in] string aName ) raises( com::sun::star::lang::IllegalArgumentException ); @@ -96,21 +99,5 @@ interface XAutoFormattable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:56 hjs - initial import - - Revision 1.3 2000/09/11 11:52:58 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/table/XCell.idl b/offapi/com/sun/star/table/XCell.idl index 0556c857ae05..672db93ac95f 100644 --- a/offapi/com/sun/star/table/XCell.idl +++ b/offapi/com/sun/star/table/XCell.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCell.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:57:04 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:42 $ * * 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_table_XCell_idl__ #define __com_sun_star_table_XCell_idl__ @@ -69,53 +70,46 @@ #include <com/sun/star/table/CellContentType.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: interface com::sun::star::table::XCell -/** represents a cell in a table.@see com::sun::star::table::Cell +/** provides methods to access the contents of a cell in a table. + + @see com::sun::star::table::Cell */ interface XCell: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XCell::getFormula - - // DocMerge from xml: method com::sun::star::table::XCell::getFormula - /** returns the formula of a cell. - <p> - Even if the cell does not contain a formula, an - assignment of this attribute's value to another cell's - formula attribute would create the same cell content. - This is because this attribute contains the original - text value of a string cell. The value of a <em>value cell</em> - will be formatted using the number format's default format - or the formula string, including "=", of a formula + + /** returns the formula string of a cell. + + <p>Even if the cell does not contain a formula, an assignment of + this attribute's value to another cell's formula attribute would + create the same cell content. This is because this attribute contains + the original text value of a string cell. The value of a + <em>value cell</em> will be formatted using the number format's + default format or the formula string, including "=", of a formula cell.</p> */ string getFormula(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XCell::setFormula /** sets a formula into the cell. - <p> - When assigned, the string will be interpreted and - a value, text or formula cell is created, depending - on the text and the number format.</p> + + <p>When assigned, the string will be interpreted and a value, text + or formula cell is created, depending on the text and the number + format.</p> */ void setFormula( [in] string aFormula ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XCell::getValue /** returns the floating point value of the cell. - - <p>For a <em>value cell</em> the value is returnd, for a <em>string cell</em> zero is returned and for a <em>formula cell</em> the result value of a formula is returned.</p> @@ -124,31 +118,25 @@ interface XCell: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XCell::setValue /** sets a floating point value into the cell. - - <p>After a call to this method the type of the cell is - <const>CellContentType::VALUE</const>.</p> + <member>CellContentType::VALUE</member>.</p> */ void setValue( [in] double nValue ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XCell::getType /** returns the type of the cell. */ com::sun::star::table::CellContentType getType(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::table::XCell::getError - /** @returns - the error value of the cell. + /** returns the error value of the cell. - <P>If the cell does not contain a formula, the error - is always zero. + <P>If the cell does not contain a formula, the error is always + zero.</p> */ long getError(); @@ -158,36 +146,5 @@ interface XCell: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/16 16:41:44 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.4 2000/12/21 08:35:19 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.2 2000/10/09 14:25:01 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.5 2000/09/11 11:52:58 mi - documentation merged from XML - - Revision 1.3 2000/03/24 13:19:37 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:59 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/table/XCellCursor.idl b/offapi/com/sun/star/table/XCellCursor.idl index 00ffdd544f38..5f64175a87de 100644 --- a/offapi/com/sun/star/table/XCellCursor.idl +++ b/offapi/com/sun/star/table/XCellCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellCursor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:43 $ * * 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_table_XCellCursor_idl__ #define __com_sun_star_table_XCellCursor_idl__ @@ -65,67 +66,63 @@ #include <com/sun/star/table/XCellRange.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: interface com::sun::star::table::XCellCursor -/** represents a cursor in a table.@see com::sun::star::table::CellCursor +/** provides methods to control the position of a cell cursor. + + @see com::sun::star::table::CellCursor */ interface XCellCursor: com::sun::star::table::XCellRange { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XCellCursor::gotoStart - /** points the cursor to a single cell which is - the beginning of a contiguous series of cells. + /** points the cursor to a single cell which is the beginning of a + contiguous series of (filled) cells. */ void gotoStart(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XCellCursor::gotoEnd - /** points the cursor to a single cell which - is the end of a contiguous series of cells. + /** points the cursor to a single cell which is the end of a contiguous + series of (filled) cells. */ void gotoEnd(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XCellCursor::gotoNext /** points the cursor to the next unprotected cell. - - - <p>If the sheet is not protected, this is the next cell - to the right.</p> + <p>If the sheet is not protected, this is the next cell to the + right.</p> */ void gotoNext(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XCellCursor::gotoPrevious /** points the cursor to the previous unprotected cell. - - - <p>If the sheet is not protected, this is the next cell - to the left.</p> + <p>If the sheet is not protected, this is the next cell to the + left.</p> */ void gotoPrevious(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XCellCursor::gotoOffset - /** points the cursor to cells off-set by - a specified number of columns and rows from those - to which it currently points. + /** moves the origin of the cursor relative to the current position. + + @param nColumnOffset + is the count of columns to move. A negative value moves the + cursor to the left. + + @param nRowOffset + is the count of rows to move. A negative value moves the + cursor to the top. */ - void gotoOffset( [in] long nColumnOffset, - [in] long nRowOffset ); + void gotoOffset( [in] long nColumnOffset, [in] long nRowOffset ); }; @@ -133,27 +130,5 @@ interface XCellCursor: com::sun::star::table::XCellRange }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:19 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.2 2000/10/09 14:25:01 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:58 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/table/XCellRange.idl b/offapi/com/sun/star/table/XCellRange.idl index a81bd7eb2f67..0850202cb959 100644 --- a/offapi/com/sun/star/table/XCellRange.idl +++ b/offapi/com/sun/star/table/XCellRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellRange.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:43 $ * * 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_table_XCellRange_idl__ #define __com_sun_star_table_XCellRange_idl__ @@ -73,97 +74,96 @@ #include <com/sun/star/table/XCell.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: interface com::sun::star::table::XCellRange -/** represents a range of cells in a table.@see com::sun::star::table::CellRange +/** provides access to the cells or to sub-ranges of a cell range. + + @see com::sun::star::table::CellRange */ interface XCellRange: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::table::XCellRange::getCellByPosition - /** @returns - the specified cell. + /** Returns a single cell within the range. + + @param nColumn + is the column index of the cell inside the range. - @param nColumn - is the column index of the cell. + @param nRow + is the row index of the cell inside the range. - @param nRow - is the row index of the cell. + @returns + the specified cell. + + @throws <type scope="com::sun::star::lang">IndexOutOfBoundsException</type> + if an index is outside the dimensions of this range. + + @see com::sun::star::table::Cell */ com::sun::star::table::XCell getCellByPosition( - [in] long nColumn, [in] long nRow ) + [in] long nColumn, + [in] long nRow ) raises( com::sun::star::lang::IndexOutOfBoundsException ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::table::XCellRange::getCellRangeByPosition - /** @returns - the specified sub-range. + /** Returns a sub-range of cells within the range. - @param nLeft - is the column index of the first cell. + @param nLeft + is the column index of the first cell inside the range. - @param nTop - is the row index of the first cell. + @param nTop + is the row index of the first cell inside the range. - @param nRight - is the column index of the last cell. + @param nRight + is the column index of the last cell inside the range. - @param nBottom - is the row index of the last cell. - */ - com::sun::star::table::XCellRange getCellRangeByPosition( [in] long nLeft, - [in] long nTop, - [in] long nRight, - [in] long nBottom ) - raises( com::sun::star::lang::IndexOutOfBoundsException ); + @param nBottom + is the row index of the last cell inside the range. - //------------------------------------------------------------------------- + @returns + the specified cell range. - // DocMerge from xml: method com::sun::star::table::XCellRange::getCellRangeByName - /** finds a cell or cell range by its name. - */ - com::sun::star::table::XCellRange getCellRangeByName( [in] string aRange ); -}; + @throws <type scope="com::sun::star::lang">IndexOutOfBoundsException</type> + if an index is outside the dimensions of this range. -//============================================================================= - -}; }; }; }; - -/*============================================================================= + @see com::sun::star::table::CellRange + */ + com::sun::star::table::XCellRange getCellRangeByPosition( + [in] long nLeft, + [in] long nTop, + [in] long nRight, + [in] long nBottom ) + raises( com::sun::star::lang::IndexOutOfBoundsException ); - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/12 12:56:24 mi - package is a registered name in Java => renamed to packages (step1: new module packages) + //------------------------------------------------------------------------- - Revision 1.4 2000/12/21 08:35:19 mi - @see interface/service/... ident -> @see ident - for new docu generator + /** Returns a sub-range of cells within the range. - Revision 1.3 2000/11/08 12:44:19 mi - moved from api + <p>The sub-range is specified by its name. The format of the range + name is dependent of the context of the table. In spreadsheets valid + names may be "A1:C5" or "$B$2" or even defined names for cell ranges + such as "MySpecialCell".</p> - Revision 1.2 2000/10/09 14:25:01 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) + @param aRange + the name of the sub-range. - Revision 1.1.1.1 2000/09/18 23:35:56 hjs - initial import + @returns + the specified cell range. - Revision 1.4 2000/09/11 11:52:58 mi - documentation merged from XML + @see com::sun::star::table::CellRange + */ + com::sun::star::table::XCellRange getCellRangeByName( [in] string aRange ); - Revision 1.2 2000/06/16 10:35:08 mi - throws exceptions now +}; - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/table/XColumnRowRange.idl b/offapi/com/sun/star/table/XColumnRowRange.idl index 9b2e0187fae0..ab590013ab16 100644 --- a/offapi/com/sun/star/table/XColumnRowRange.idl +++ b/offapi/com/sun/star/table/XColumnRowRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: XColumnRowRange.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:43 $ * * 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_table_XColumnRowRange_idl__ #define __com_sun_star_table_XColumnRowRange_idl__ @@ -73,32 +74,32 @@ #include <com/sun/star/table/XTableRows.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: interface com::sun::star::table::XColumnRowRange -/** enables accessing the columns and rows of - a cell range.@see com::sun::star::table::CellRange +/** provides methods to access the collections of columns and rows + of a cell range. + + @see com::sun::star::table::CellRange */ interface XColumnRowRange: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::table::XColumnRowRange::getColumns - /** This attribute returns the collection of columns - in the range. + /** returns the collection of columns in the range. + + @see com::sun::star::table::TableColumns */ com::sun::star::table::XTableColumns getColumns(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::table::XColumnRowRange::getRows - /** This attribute returns the collection of rows - in the range. + /** returns the collection of rows in the range. + + @see com::sun::star::table::TableRows */ com::sun::star::table::XTableRows getRows(); @@ -108,27 +109,5 @@ interface XColumnRowRange: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:19 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.2 2000/10/09 14:25:01 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:56 hjs - initial import - - Revision 1.3 2000/09/11 11:52:58 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/table/XTableChart.idl b/offapi/com/sun/star/table/XTableChart.idl index 72560464bcdf..77ace4c5fae3 100644 --- a/offapi/com/sun/star/table/XTableChart.idl +++ b/offapi/com/sun/star/table/XTableChart.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTableChart.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:43 $ * * 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_table_XTableChart_idl__ #define __com_sun_star_table_XTableChart_idl__ @@ -69,62 +70,59 @@ #include <com/sun/star/table/CellRangeAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge: empty anyway +/** provides access to the settings of a chart object in a table or + spreadsheet. + + @see com::sun::star::table::TableChart + */ interface XTableChart: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::table::XTableChart::getHasColumnHeaders - /** @returns - whether the first row of data is interpreted as column headers or data. + /** returns, whether the cells of the topmost row of the source data + are interpreted as column headers. */ boolean getHasColumnHeaders(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XTableChart::setHasColumnHeaders - /** specifies whether the first row of data is interpreted as column headers or data. + /** specifies whether the cells of the topmost row of the source data + are interpreted as column headers. */ void setHasColumnHeaders( [in] boolean bHasColumnHeaders ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::table::XTableChart::getHasRowHeaders - /** @returns - whether the first column of data is interpreted as row headers or data. + /** returns, whether the cells of the leftmost column of the source + data are interpreted as row headers. */ boolean getHasRowHeaders(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XTableChart::setHasRowHeaders - /** specifies whether the first column of data is interpreted as row headers or data. + /** specifies whether the cells of the leftmost column of the source + data are interpreted as row headers. */ void setHasRowHeaders( [in] boolean bHasRowHeaders ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XTableChart::getRanges - // DocMerge from idl: method com::sun::star::table::XTableChart::getRanges - /** @returns - the cell ranges that contain the data for the chart. + /** returns the cell ranges that contain the data for the chart. */ sequence<com::sun::star::table::CellRangeAddress> getRanges(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XTableChart::setRanges - /** sets the cell ranges that contain the data - for the chart. + /** sets the cell ranges that contain the data for the chart. */ - void setRanges( [in] sequence<com::sun::star::table::CellRangeAddress> aRanges ); + void setRanges( + [in] sequence<com::sun::star::table::CellRangeAddress> aRanges ); }; @@ -132,27 +130,5 @@ interface XTableChart: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:56 hjs - initial import - - Revision 1.5 2000/09/11 11:52:58 mi - documentation merged from XML - - Revision 1.3 2000/03/24 13:20:11 nn - #74032# documentation added - - Revision 1.2 2000/01/31 10:48:16 mi - #72484# UIKs were not unique - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/table/XTableCharts.idl b/offapi/com/sun/star/table/XTableCharts.idl index 556c25e35d48..98f01c24a98a 100644 --- a/offapi/com/sun/star/table/XTableCharts.idl +++ b/offapi/com/sun/star/table/XTableCharts.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTableCharts.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:44 $ * * 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_table_XTableCharts_idl__ #define __com_sun_star_table_XTableCharts_idl__ @@ -73,31 +74,55 @@ #include <com/sun/star/table/CellRangeAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge: empty anyway +/** provides methods to access charts via name and to insert and remove + charts. + + @see com::sun::star::table::TableCharts + */ interface XTableCharts: com::sun::star::container::XNameAccess { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XTableCharts::addNewByName /** creates a chart and adds it to the collection. + + @param aName + is the name of the chart. This name is used to reference the + chart in the collection. + + @param aRect + contains the rectangular location of the chart within the table + (in 1/100th mm). + + @param aRanges + all cell ranges containing the source data of the chart. + + @param bColumnHeaders + if set to <TRUE/>, the topmost row of the source data will be + used to set labels for the category axis or the legend. + + @param bRowHeaders + if set to <TRUE/>, the leftmost column of the source data will + be used to set labels for the category axis or the legend. */ - void addNewByName( [in] string aName, - [in] com::sun::star::awt::Rectangle aRect, - [in] sequence<com::sun::star::table::CellRangeAddress> aRanges, - [in] boolean bColumnHeaders, - [in] boolean bRowHeaders ); + void addNewByName( + [in] string aName, + [in] com::sun::star::awt::Rectangle aRect, + [in] sequence<com::sun::star::table::CellRangeAddress> aRanges, + [in] boolean bColumnHeaders, + [in] boolean bRowHeaders ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XTableCharts::removeByName /** removes a chart from the collection. + + @param aName + is the name of the chart to remove. */ void removeByName( [in] string aName ); @@ -107,24 +132,5 @@ interface XTableCharts: com::sun::star::container::XNameAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:56 hjs - initial import - - Revision 1.4 2000/09/11 11:52:58 mi - documentation merged from XML - - Revision 1.2 2000/01/31 10:54:22 mi - #72484# UIKs were not unique - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/table/XTableChartsSupplier.idl b/offapi/com/sun/star/table/XTableChartsSupplier.idl index b36cfa486208..8a5d3df5ad39 100644 --- a/offapi/com/sun/star/table/XTableChartsSupplier.idl +++ b/offapi/com/sun/star/table/XTableChartsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTableChartsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:44 $ * * 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_table_XTableChartsSupplier_idl__ #define __com_sun_star_table_XTableChartsSupplier_idl__ @@ -69,20 +70,22 @@ #include <com/sun/star/table/XTableCharts.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge: empty anyway +/** provides a method to access a collection of charts in a table or + spreadsheet. + */ interface XTableChartsSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XTableChartsSupplier::getCharts /** returns the collection of charts. + + @see com::sun::star::table::TableCharts */ com::sun::star::table::XTableCharts getCharts(); @@ -92,21 +95,5 @@ interface XTableChartsSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:56 hjs - initial import - - Revision 1.3 2000/09/11 11:52:58 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/table/XTableColumns.idl b/offapi/com/sun/star/table/XTableColumns.idl index 7261619930bc..986c7a81927f 100644 --- a/offapi/com/sun/star/table/XTableColumns.idl +++ b/offapi/com/sun/star/table/XTableColumns.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTableColumns.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:44 $ * * 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_table_XTableColumns_idl__ #define __com_sun_star_table_XTableColumns_idl__ @@ -65,33 +66,42 @@ #include <com/sun/star/container/XIndexAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: interface com::sun::star::table::XTableColumns -/** represents a collection of columns in a table.@see TableColumns +/** provides methods to access columns via index and to insert and remove + columns. + + @see com::sun::star::table::TableColumns */ interface XTableColumns: com::sun::star::container::XIndexAccess { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XTableColumns::insertByIndex /** inserts new columns. + + @param nIndex + is the index the first inserted column will have. + + @param nCount + is the number of columns to insert. */ - void insertByIndex( [in] long nIndex, - [in] long nCount ); + void insertByIndex( [in] long nIndex, [in] long nCount ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XTableColumns::removeByIndex /** deletes columns. + + @param nIndex + is the index of the first column to delete. + + @param nCount + is the number of columns to delete. */ - void removeByIndex( [in] long nIndex, - [in] long nCount ); + void removeByIndex( [in] long nIndex, [in] long nCount ); }; @@ -99,24 +109,5 @@ interface XTableColumns: com::sun::star::container::XIndexAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:19 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:56 hjs - initial import - - Revision 1.3 2000/09/11 11:52:58 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/table/XTableRows.idl b/offapi/com/sun/star/table/XTableRows.idl index c11e9c7b03c5..1265e008d6e7 100644 --- a/offapi/com/sun/star/table/XTableRows.idl +++ b/offapi/com/sun/star/table/XTableRows.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTableRows.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:44 $ * * 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_table_XTableRows_idl__ #define __com_sun_star_table_XTableRows_idl__ @@ -65,33 +66,41 @@ #include <com/sun/star/container/XIndexAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module table { +module com { module sun { module star { module table { //============================================================================= -// DocMerge from xml: interface com::sun::star::table::XTableRows -/** represents a collection of rows in a table.@see TableRows +/** provides methods to access rows via index and to insert and remove rows. + + @see com::sun::star::table::TableRows */ interface XTableRows: com::sun::star::container::XIndexAccess { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XTableRows::insertByIndex /** inserts new rows. + + @param nIndex + is the index the first inserted row will have. + + @param nCount + is the number of rows to insert. */ - void insertByIndex( [in] long nIndex, - [in] long nCount ); + void insertByIndex( [in] long nIndex, [in] long nCount ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::table::XTableRows::removeByIndex /** deletes rows. + + @param nIndex + is the index of the first row to delete. + + @param nCount + is the number of rows to delete. */ - void removeByIndex( [in] long nIndex, - [in] long nCount ); + void removeByIndex( [in] long nIndex, [in] long nCount ); }; @@ -99,24 +108,5 @@ interface XTableRows: com::sun::star::container::XIndexAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:19 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:56 hjs - initial import - - Revision 1.3 2000/09/11 11:52:58 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif + |